Class: Aws::MediaPackageV2::Types::CreateOriginEndpointRequest

Inherits:

Struct

• Object
• Struct
• Aws::MediaPackageV2::Types::CreateOriginEndpointRequest

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.

• #container_type ⇒ String

  The type of container to attach to this origin endpoint.

• #dash_manifests ⇒ Array<Types::CreateDashManifestConfiguration>

  A DASH manifest configuration.

• #description ⇒ String

  Enter any descriptive text that helps you to identify the origin endpoint.

• #force_endpoint_error_configuration ⇒ Types::ForceEndpointErrorConfiguration

  The failover settings for the endpoint.

• #hls_manifests ⇒ Array<Types::CreateHlsManifestConfiguration>

  An HTTP live streaming (HLS) manifest configuration.

• #low_latency_hls_manifests ⇒ Array<Types::CreateLowLatencyHlsManifestConfiguration>

  A low-latency HLS manifest configuration.

• #mss_manifests ⇒ Array<Types::CreateMssManifestConfiguration>

  A list of Microsoft Smooth Streaming (MSS) manifest configurations for the origin endpoint.

• #origin_endpoint_name ⇒ String

  The name that describes the origin endpoint.

• #segment ⇒ Types::Segment

  The segment configuration, including the segment name, duration, and other configuration values.

• #startover_window_seconds ⇒ Integer

  The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing.

• #stream_name_output_mode ⇒ String

  The output mode for stream names in egress manifests.

• #tags ⇒ Hash<String,String>

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

• #uri_separator ⇒ String

  The separator character to use in generated URIs for this origin endpoint.

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 1224

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_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.

Returns:

• (String)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_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)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#container_type ⇒ String

The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.

Returns:

• (String)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dash_manifests ⇒ Array<Types::CreateDashManifestConfiguration>

A DASH manifest configuration.

Returns:

• (Array<Types::CreateDashManifestConfiguration>)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Enter any descriptive text that helps you to identify the origin endpoint.

Returns:

• (String)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#force_endpoint_error_configuration ⇒ Types::ForceEndpointErrorConfiguration

The failover settings for the endpoint.

Returns:

• (Types::ForceEndpointErrorConfiguration)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hls_manifests ⇒ Array<Types::CreateHlsManifestConfiguration>

An HTTP live streaming (HLS) manifest configuration.

Returns:

• (Array<Types::CreateHlsManifestConfiguration>)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#low_latency_hls_manifests ⇒ Array<Types::CreateLowLatencyHlsManifestConfiguration>

A low-latency HLS manifest configuration.

Returns:

• (Array<Types::CreateLowLatencyHlsManifestConfiguration>)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#mss_manifests ⇒ Array<Types::CreateMssManifestConfiguration>

A list of Microsoft Smooth Streaming (MSS) manifest configurations for the origin endpoint. You can configure multiple MSS manifests to provide different streaming experiences or to support different client requirements.

Returns:

• (Array<Types::CreateMssManifestConfiguration>)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#origin_endpoint_name ⇒ String

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

Returns:

• (String)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#segment ⇒ Types::Segment

The segment configuration, including the segment name, duration, and other configuration values.

Returns:

• (Types::Segment)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#startover_window_seconds ⇒ Integer

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

Returns:

• (Integer)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name_output_mode ⇒ String

The output mode for stream names in egress manifests. This setting is valid only when the associated channel's InputType is HLS. You can't change the stream name output mode after you create the endpoint.

INDEX uses numeric indices for stream names (for example, 1, 2, 3). PASSTHROUGH_NAME uses the stream names from the input manifest. If you don't specify a value, the default is INDEX.

Returns:

• (String)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_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>)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#uri_separator ⇒ String

The separator character to use in generated URIs for this origin endpoint. This setting applies to all manifest types on the endpoint. If you don't specify a value, the default is UNDERSCORE.

Returns:

• (String)

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

class CreateOriginEndpointRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :container_type,
  :segment,
  :client_token,
  :description,
  :startover_window_seconds,
  :hls_manifests,
  :low_latency_hls_manifests,
  :dash_manifests,
  :mss_manifests,
  :force_endpoint_error_configuration,
  :uri_separator,
  :stream_name_output_mode,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end