aws_sdk_mediapackagev2/client/

create_origin_endpoint.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateOriginEndpoint`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`channel_group_name(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>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.</p><br>
    ///   - [`channel_name(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_channel_name):<br>required: **true**<br><p>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.</p><br>
    ///   - [`origin_endpoint_name(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_origin_endpoint_name):<br>required: **true**<br><p>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.</p><br>
    ///   - [`container_type(ContainerType)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::container_type) / [`set_container_type(Option<ContainerType>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_container_type):<br>required: **true**<br><p>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.</p><br>
    ///   - [`segment(Segment)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::segment) / [`set_segment(Option<Segment>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_segment):<br>required: **false**<br><p>The segment configuration, including the segment name, duration, and other configuration values.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_description):<br>required: **false**<br><p>Enter any descriptive text that helps you to identify the origin endpoint.</p><br>
    ///   - [`startover_window_seconds(i32)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::startover_window_seconds) / [`set_startover_window_seconds(Option<i32>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_startover_window_seconds):<br>required: **false**<br><p>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).</p><br>
    ///   - [`hls_manifests(CreateHlsManifestConfiguration)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::hls_manifests) / [`set_hls_manifests(Option<Vec::<CreateHlsManifestConfiguration>>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_hls_manifests):<br>required: **false**<br><p>An HTTP live streaming (HLS) manifest configuration.</p><br>
    ///   - [`low_latency_hls_manifests(CreateLowLatencyHlsManifestConfiguration)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::low_latency_hls_manifests) / [`set_low_latency_hls_manifests(Option<Vec::<CreateLowLatencyHlsManifestConfiguration>>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_low_latency_hls_manifests):<br>required: **false**<br><p>A low-latency HLS manifest configuration.</p><br>
    ///   - [`dash_manifests(CreateDashManifestConfiguration)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::dash_manifests) / [`set_dash_manifests(Option<Vec::<CreateDashManifestConfiguration>>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_dash_manifests):<br>required: **false**<br><p>A DASH manifest configuration.</p><br>
    ///   - [`force_endpoint_error_configuration(ForceEndpointErrorConfiguration)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::force_endpoint_error_configuration) / [`set_force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_force_endpoint_error_configuration):<br>required: **false**<br><p>The failover settings for the endpoint.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_tags):<br>required: **false**<br><p>A comma-separated list of tag key:value pairs that you define. For example:</p> <p><code>"Key1": "Value1",</code></p> <p><code>"Key2": "Value2"</code></p><br>
    /// - On success, responds with [`CreateOriginEndpointOutput`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput) with field(s):
    ///   - [`arn(String)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::arn): <p>The Amazon Resource Name (ARN) associated with the resource.</p>
    ///   - [`channel_group_name(String)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::channel_group_name): <p>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.</p>
    ///   - [`channel_name(String)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::channel_name): <p>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.</p>
    ///   - [`origin_endpoint_name(String)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::origin_endpoint_name): <p>The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.</p>
    ///   - [`container_type(ContainerType)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::container_type): <p>The type of container attached to this origin endpoint.</p>
    ///   - [`segment(Option<Segment>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::segment): <p>The segment configuration, including the segment name, duration, and other configuration values.</p>
    ///   - [`created_at(DateTime)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::created_at): <p>The date and time the origin endpoint was created.</p>
    ///   - [`modified_at(DateTime)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::modified_at): <p>The date and time the origin endpoint was modified.</p>
    ///   - [`description(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::description): <p>The description for your origin endpoint.</p>
    ///   - [`startover_window_seconds(Option<i32>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::startover_window_seconds): <p>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.</p>
    ///   - [`hls_manifests(Option<Vec::<GetHlsManifestConfiguration>>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::hls_manifests): <p>An HTTP live streaming (HLS) manifest configuration.</p>
    ///   - [`low_latency_hls_manifests(Option<Vec::<GetLowLatencyHlsManifestConfiguration>>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::low_latency_hls_manifests): <p>A low-latency HLS manifest configuration.</p>
    ///   - [`dash_manifests(Option<Vec::<GetDashManifestConfiguration>>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::dash_manifests): <p>A DASH manifest configuration.</p>
    ///   - [`force_endpoint_error_configuration(Option<ForceEndpointErrorConfiguration>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::force_endpoint_error_configuration): <p>The failover settings for the endpoint.</p>
    ///   - [`e_tag(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::e_tag): <p>The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::tags): <p>The comma-separated list of tag key:value pairs assigned to the origin endpoint.</p>
    /// - On failure, responds with [`SdkError<CreateOriginEndpointError>`](crate::operation::create_origin_endpoint::CreateOriginEndpointError)
    pub fn create_origin_endpoint(&self) -> crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder {
        crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::new(self.handle.clone())
    }
}