aws_sdk_mediapackage/client/
create_origin_endpoint.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateOriginEndpoint`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authorization(Authorization)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::authorization) / [`set_authorization(Option<Authorization>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_authorization):<br>required: **false**<br>CDN Authorization credentials<br>
7    ///   - [`channel_id(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::channel_id) / [`set_channel_id(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_channel_id):<br>required: **true**<br>The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.<br>
8    ///   - [`cmaf_package(CmafPackageCreateOrUpdateParameters)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::cmaf_package) / [`set_cmaf_package(Option<CmafPackageCreateOrUpdateParameters>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_cmaf_package):<br>required: **false**<br>A Common Media Application Format (CMAF) packaging configuration.<br>
9    ///   - [`dash_package(DashPackage)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::dash_package) / [`set_dash_package(Option<DashPackage>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_dash_package):<br>required: **false**<br>A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.<br>
10    ///   - [`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>A short text description of the OriginEndpoint.<br>
11    ///   - [`hls_package(HlsPackage)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::hls_package) / [`set_hls_package(Option<HlsPackage>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_hls_package):<br>required: **false**<br>An HTTP Live Streaming (HLS) packaging configuration.<br>
12    ///   - [`id(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_id):<br>required: **true**<br>The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created.<br>
13    ///   - [`manifest_name(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::manifest_name) / [`set_manifest_name(Option<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_manifest_name):<br>required: **false**<br>A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").<br>
14    ///   - [`mss_package(MssPackage)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::mss_package) / [`set_mss_package(Option<MssPackage>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_mss_package):<br>required: **false**<br>A Microsoft Smooth Streaming (MSS) packaging configuration.<br>
15    ///   - [`origination(Origination)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::origination) / [`set_origination(Option<Origination>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_origination):<br>required: **false**<br>Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination<br>
16    ///   - [`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>Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.<br>
17    ///   - [`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>A collection of tags associated with a resource<br>
18    ///   - [`time_delay_seconds(i32)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::time_delay_seconds) / [`set_time_delay_seconds(Option<i32>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_time_delay_seconds):<br>required: **false**<br>Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.<br>
19    ///   - [`whitelist(impl Into<String>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::whitelist) / [`set_whitelist(Option<Vec::<String>>)`](crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::set_whitelist):<br>required: **false**<br>A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.<br>
20    /// - On success, responds with [`CreateOriginEndpointOutput`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput) with field(s):
21    ///   - [`arn(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::arn): The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
22    ///   - [`authorization(Option<Authorization>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::authorization): CDN Authorization credentials
23    ///   - [`channel_id(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::channel_id): The ID of the Channel the OriginEndpoint is associated with.
24    ///   - [`cmaf_package(Option<CmafPackage>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::cmaf_package): A Common Media Application Format (CMAF) packaging configuration.
25    ///   - [`created_at(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::created_at): The date and time the OriginEndpoint was created.
26    ///   - [`dash_package(Option<DashPackage>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::dash_package): A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
27    ///   - [`description(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::description): A short text description of the OriginEndpoint.
28    ///   - [`hls_package(Option<HlsPackage>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::hls_package): An HTTP Live Streaming (HLS) packaging configuration.
29    ///   - [`id(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::id): The ID of the OriginEndpoint.
30    ///   - [`manifest_name(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::manifest_name): A short string appended to the end of the OriginEndpoint URL.
31    ///   - [`mss_package(Option<MssPackage>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::mss_package): A Microsoft Smooth Streaming (MSS) packaging configuration.
32    ///   - [`origination(Option<Origination>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::origination): Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
33    ///   - [`startover_window_seconds(Option<i32>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::startover_window_seconds): Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
34    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::tags): A collection of tags associated with a resource
35    ///   - [`time_delay_seconds(Option<i32>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::time_delay_seconds): Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
36    ///   - [`url(Option<String>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::url): The URL of the packaged OriginEndpoint for consumption.
37    ///   - [`whitelist(Option<Vec::<String>>)`](crate::operation::create_origin_endpoint::CreateOriginEndpointOutput::whitelist): A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
38    /// - On failure, responds with [`SdkError<CreateOriginEndpointError>`](crate::operation::create_origin_endpoint::CreateOriginEndpointError)
39    pub fn create_origin_endpoint(&self) -> crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder {
40        crate::operation::create_origin_endpoint::builders::CreateOriginEndpointFluentBuilder::new(self.handle.clone())
41    }
42}