aws_sdk_ivsrealtime/operation/create_ingest_configuration/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_ingest_configuration::_create_ingest_configuration_output::CreateIngestConfigurationOutputBuilder;
3
4pub use crate::operation::create_ingest_configuration::_create_ingest_configuration_input::CreateIngestConfigurationInputBuilder;
5
6impl crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_ingest_configuration::CreateIngestConfigurationError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_ingest_configuration();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateIngestConfiguration`.
24///
25/// <p>Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateIngestConfigurationFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput,
35 crate::operation::create_ingest_configuration::CreateIngestConfigurationError,
36 > for CreateIngestConfigurationFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput,
44 crate::operation::create_ingest_configuration::CreateIngestConfigurationError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl CreateIngestConfigurationFluentBuilder {
51 /// Creates a new `CreateIngestConfigurationFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the CreateIngestConfiguration as a reference.
60 pub fn as_input(&self) -> &crate::operation::create_ingest_configuration::builders::CreateIngestConfigurationInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::create_ingest_configuration::CreateIngestConfigurationError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::create_ingest_configuration::CreateIngestConfiguration::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::create_ingest_configuration::CreateIngestConfiguration::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::create_ingest_configuration::CreateIngestConfigurationOutput,
97 crate::operation::create_ingest_configuration::CreateIngestConfigurationError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>Optional name that can be specified for the IngestConfiguration being created.</p>
112 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.name(input.into());
114 self
115 }
116 /// <p>Optional name that can be specified for the IngestConfiguration being created.</p>
117 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_name(input);
119 self
120 }
121 /// <p>Optional name that can be specified for the IngestConfiguration being created.</p>
122 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_name()
124 }
125 /// <p>ARN of the stage with which the IngestConfiguration is associated.</p>
126 pub fn stage_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127 self.inner = self.inner.stage_arn(input.into());
128 self
129 }
130 /// <p>ARN of the stage with which the IngestConfiguration is associated.</p>
131 pub fn set_stage_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132 self.inner = self.inner.set_stage_arn(input);
133 self
134 }
135 /// <p>ARN of the stage with which the IngestConfiguration is associated.</p>
136 pub fn get_stage_arn(&self) -> &::std::option::Option<::std::string::String> {
137 self.inner.get_stage_arn()
138 }
139 /// <p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
140 pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141 self.inner = self.inner.user_id(input.into());
142 self
143 }
144 /// <p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
145 pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146 self.inner = self.inner.set_user_id(input);
147 self
148 }
149 /// <p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
150 pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
151 self.inner.get_user_id()
152 }
153 ///
154 /// Adds a key-value pair to `attributes`.
155 ///
156 /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
157 ///
158 /// <p>Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
159 pub fn attributes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
160 self.inner = self.inner.attributes(k.into(), v.into());
161 self
162 }
163 /// <p>Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
164 pub fn set_attributes(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
165 self.inner = self.inner.set_attributes(input);
166 self
167 }
168 /// <p>Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></p>
169 pub fn get_attributes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
170 self.inner.get_attributes()
171 }
172 /// <p>Type of ingest protocol that the user employs to broadcast. If this is set to <code>RTMP</code>, <code>insecureIngest</code> must be set to <code>true</code>.</p>
173 pub fn ingest_protocol(mut self, input: crate::types::IngestProtocol) -> Self {
174 self.inner = self.inner.ingest_protocol(input);
175 self
176 }
177 /// <p>Type of ingest protocol that the user employs to broadcast. If this is set to <code>RTMP</code>, <code>insecureIngest</code> must be set to <code>true</code>.</p>
178 pub fn set_ingest_protocol(mut self, input: ::std::option::Option<crate::types::IngestProtocol>) -> Self {
179 self.inner = self.inner.set_ingest_protocol(input);
180 self
181 }
182 /// <p>Type of ingest protocol that the user employs to broadcast. If this is set to <code>RTMP</code>, <code>insecureIngest</code> must be set to <code>true</code>.</p>
183 pub fn get_ingest_protocol(&self) -> &::std::option::Option<crate::types::IngestProtocol> {
184 self.inner.get_ingest_protocol()
185 }
186 /// <p>Whether the stage allows insecure RTMP ingest. This must be set to <code>true</code>, if <code>ingestProtocol</code> is set to <code>RTMP</code>. Default: <code>false</code>.</p>
187 pub fn insecure_ingest(mut self, input: bool) -> Self {
188 self.inner = self.inner.insecure_ingest(input);
189 self
190 }
191 /// <p>Whether the stage allows insecure RTMP ingest. This must be set to <code>true</code>, if <code>ingestProtocol</code> is set to <code>RTMP</code>. Default: <code>false</code>.</p>
192 pub fn set_insecure_ingest(mut self, input: ::std::option::Option<bool>) -> Self {
193 self.inner = self.inner.set_insecure_ingest(input);
194 self
195 }
196 /// <p>Whether the stage allows insecure RTMP ingest. This must be set to <code>true</code>, if <code>ingestProtocol</code> is set to <code>RTMP</code>. Default: <code>false</code>.</p>
197 pub fn get_insecure_ingest(&self) -> &::std::option::Option<bool> {
198 self.inner.get_insecure_ingest()
199 }
200 ///
201 /// Adds a key-value pair to `tags`.
202 ///
203 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
204 ///
205 /// <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
206 pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
207 self.inner = self.inner.tags(k.into(), v.into());
208 self
209 }
210 /// <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
211 pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
212 self.inner = self.inner.set_tags(input);
213 self
214 }
215 /// <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
216 pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
217 self.inner.get_tags()
218 }
219}