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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :multiview_configuration,
  :output_locking_mode,
  :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) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :multiview_configuration,
  :output_locking_mode,
  :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) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

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

#description ⇒ String

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

Returns:

  • (String) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :multiview_configuration,
  :output_locking_mode,
  :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:



461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

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

#input_type ⇒ String

The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

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).

  • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

Returns:

  • (String) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

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

#multiview_configuration ⇒ Types::MultiviewConfiguration

The multiview configuration for the channel. This setting is required when InputType is MULTIVIEW, and can't be set for any other input type.

Returns:



461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :multiview_configuration,
  :output_locking_mode,
  :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:



461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

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

#output_locking_mode ⇒ String

The output locking mode for the channel. This setting is only valid when InputType is CMAF. This value is immutable after channel creation. If you don't specify a value, the default is EPOCH_LOCKED.

The allowed values are:

  • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time. This mode supports cross-region synchronization and failover.

  • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0. This mode does not support cross-region synchronization or failover.

Returns:

  • (String) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

class CreateChannelRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :client_token,
  :input_type,
  :description,
  :input_switch_configuration,
  :output_header_configuration,
  :multiview_configuration,
  :output_locking_mode,
  :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>) 


461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 461

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