aws_sdk_pipes/operation/create_pipe/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_pipe::_create_pipe_output::CreatePipeOutputBuilder;
3
4pub use crate::operation::create_pipe::_create_pipe_input::CreatePipeInputBuilder;
5
6impl crate::operation::create_pipe::builders::CreatePipeInputBuilder {
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_pipe::CreatePipeOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_pipe::CreatePipeError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_pipe();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreatePipe`.
24///
25/// <p>Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreatePipeFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_pipe::builders::CreatePipeInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_pipe::CreatePipeOutput,
35        crate::operation::create_pipe::CreatePipeError,
36    > for CreatePipeFluentBuilder
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_pipe::CreatePipeOutput,
44            crate::operation::create_pipe::CreatePipeError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreatePipeFluentBuilder {
51    /// Creates a new `CreatePipeFluentBuilder`.
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 CreatePipe as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_pipe::builders::CreatePipeInputBuilder {
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_pipe::CreatePipeOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_pipe::CreatePipeError,
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_pipe::CreatePipe::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_pipe::CreatePipe::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_pipe::CreatePipeOutput,
97        crate::operation::create_pipe::CreatePipeError,
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>The name of the pipe.</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>The name of the pipe.</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>The name of the pipe.</p>
122    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_name()
124    }
125    /// <p>A description of the pipe.</p>
126    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.description(input.into());
128        self
129    }
130    /// <p>A description of the pipe.</p>
131    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_description(input);
133        self
134    }
135    /// <p>A description of the pipe.</p>
136    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_description()
138    }
139    /// <p>The state the pipe should be in.</p>
140    pub fn desired_state(mut self, input: crate::types::RequestedPipeState) -> Self {
141        self.inner = self.inner.desired_state(input);
142        self
143    }
144    /// <p>The state the pipe should be in.</p>
145    pub fn set_desired_state(mut self, input: ::std::option::Option<crate::types::RequestedPipeState>) -> Self {
146        self.inner = self.inner.set_desired_state(input);
147        self
148    }
149    /// <p>The state the pipe should be in.</p>
150    pub fn get_desired_state(&self) -> &::std::option::Option<crate::types::RequestedPipeState> {
151        self.inner.get_desired_state()
152    }
153    /// <p>The ARN of the source resource.</p>
154    pub fn source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.source(input.into());
156        self
157    }
158    /// <p>The ARN of the source resource.</p>
159    pub fn set_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_source(input);
161        self
162    }
163    /// <p>The ARN of the source resource.</p>
164    pub fn get_source(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_source()
166    }
167    /// <p>The parameters required to set up a source for your pipe.</p>
168    pub fn source_parameters(mut self, input: crate::types::PipeSourceParameters) -> Self {
169        self.inner = self.inner.source_parameters(input);
170        self
171    }
172    /// <p>The parameters required to set up a source for your pipe.</p>
173    pub fn set_source_parameters(mut self, input: ::std::option::Option<crate::types::PipeSourceParameters>) -> Self {
174        self.inner = self.inner.set_source_parameters(input);
175        self
176    }
177    /// <p>The parameters required to set up a source for your pipe.</p>
178    pub fn get_source_parameters(&self) -> &::std::option::Option<crate::types::PipeSourceParameters> {
179        self.inner.get_source_parameters()
180    }
181    /// <p>The ARN of the enrichment resource.</p>
182    pub fn enrichment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
183        self.inner = self.inner.enrichment(input.into());
184        self
185    }
186    /// <p>The ARN of the enrichment resource.</p>
187    pub fn set_enrichment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188        self.inner = self.inner.set_enrichment(input);
189        self
190    }
191    /// <p>The ARN of the enrichment resource.</p>
192    pub fn get_enrichment(&self) -> &::std::option::Option<::std::string::String> {
193        self.inner.get_enrichment()
194    }
195    /// <p>The parameters required to set up enrichment on your pipe.</p>
196    pub fn enrichment_parameters(mut self, input: crate::types::PipeEnrichmentParameters) -> Self {
197        self.inner = self.inner.enrichment_parameters(input);
198        self
199    }
200    /// <p>The parameters required to set up enrichment on your pipe.</p>
201    pub fn set_enrichment_parameters(mut self, input: ::std::option::Option<crate::types::PipeEnrichmentParameters>) -> Self {
202        self.inner = self.inner.set_enrichment_parameters(input);
203        self
204    }
205    /// <p>The parameters required to set up enrichment on your pipe.</p>
206    pub fn get_enrichment_parameters(&self) -> &::std::option::Option<crate::types::PipeEnrichmentParameters> {
207        self.inner.get_enrichment_parameters()
208    }
209    /// <p>The ARN of the target resource.</p>
210    pub fn target(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
211        self.inner = self.inner.target(input.into());
212        self
213    }
214    /// <p>The ARN of the target resource.</p>
215    pub fn set_target(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
216        self.inner = self.inner.set_target(input);
217        self
218    }
219    /// <p>The ARN of the target resource.</p>
220    pub fn get_target(&self) -> &::std::option::Option<::std::string::String> {
221        self.inner.get_target()
222    }
223    /// <p>The parameters required to set up a target for your pipe.</p>
224    /// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
225    pub fn target_parameters(mut self, input: crate::types::PipeTargetParameters) -> Self {
226        self.inner = self.inner.target_parameters(input);
227        self
228    }
229    /// <p>The parameters required to set up a target for your pipe.</p>
230    /// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
231    pub fn set_target_parameters(mut self, input: ::std::option::Option<crate::types::PipeTargetParameters>) -> Self {
232        self.inner = self.inner.set_target_parameters(input);
233        self
234    }
235    /// <p>The parameters required to set up a target for your pipe.</p>
236    /// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
237    pub fn get_target_parameters(&self) -> &::std::option::Option<crate::types::PipeTargetParameters> {
238        self.inner.get_target_parameters()
239    }
240    /// <p>The ARN of the role that allows the pipe to send data to the target.</p>
241    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
242        self.inner = self.inner.role_arn(input.into());
243        self
244    }
245    /// <p>The ARN of the role that allows the pipe to send data to the target.</p>
246    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
247        self.inner = self.inner.set_role_arn(input);
248        self
249    }
250    /// <p>The ARN of the role that allows the pipe to send data to the target.</p>
251    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
252        self.inner.get_role_arn()
253    }
254    ///
255    /// Adds a key-value pair to `Tags`.
256    ///
257    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
258    ///
259    /// <p>The list of key-value pairs to associate with the pipe.</p>
260    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
261        self.inner = self.inner.tags(k.into(), v.into());
262        self
263    }
264    /// <p>The list of key-value pairs to associate with the pipe.</p>
265    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
266        self.inner = self.inner.set_tags(input);
267        self
268    }
269    /// <p>The list of key-value pairs to associate with the pipe.</p>
270    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
271        self.inner.get_tags()
272    }
273    /// <p>The logging configuration settings for the pipe.</p>
274    pub fn log_configuration(mut self, input: crate::types::PipeLogConfigurationParameters) -> Self {
275        self.inner = self.inner.log_configuration(input);
276        self
277    }
278    /// <p>The logging configuration settings for the pipe.</p>
279    pub fn set_log_configuration(mut self, input: ::std::option::Option<crate::types::PipeLogConfigurationParameters>) -> Self {
280        self.inner = self.inner.set_log_configuration(input);
281        self
282    }
283    /// <p>The logging configuration settings for the pipe.</p>
284    pub fn get_log_configuration(&self) -> &::std::option::Option<crate::types::PipeLogConfigurationParameters> {
285        self.inner.get_log_configuration()
286    }
287    /// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
288    /// <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.</p>
289    /// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
290    pub fn kms_key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
291        self.inner = self.inner.kms_key_identifier(input.into());
292        self
293    }
294    /// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
295    /// <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.</p>
296    /// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
297    pub fn set_kms_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
298        self.inner = self.inner.set_kms_key_identifier(input);
299        self
300    }
301    /// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
302    /// <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.</p>
303    /// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
304    pub fn get_kms_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
305        self.inner.get_kms_key_identifier()
306    }
307}