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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_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.

Returns:

  • (String) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_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) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :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) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dash_manifests ⇒ Array<Types::CreateDashManifestConfiguration>

A DASH manifest configuration.

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

  • (String) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#force_endpoint_error_configuration ⇒ Types::ForceEndpointErrorConfiguration

The failover settings for the endpoint.

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#hls_manifests ⇒ Array<Types::CreateHlsManifestConfiguration>

An HTTP live streaming (HLS) manifest configuration.

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#low_latency_hls_manifests ⇒ Array<Types::CreateLowLatencyHlsManifestConfiguration>

A low-latency HLS manifest configuration.

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :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) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#segment ⇒ Types::Segment

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

Returns:



904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :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) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_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>) 


904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/aws-sdk-mediapackagev2/types.rb', line 904

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,
  :force_endpoint_error_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end