aws_sdk_eventbridge/operation/delete_rule/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_rule::_delete_rule_output::DeleteRuleOutputBuilder;
3
4pub use crate::operation::delete_rule::_delete_rule_input::DeleteRuleInputBuilder;
5
6impl crate::operation::delete_rule::builders::DeleteRuleInputBuilder {
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::delete_rule::DeleteRuleOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::delete_rule::DeleteRuleError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.delete_rule();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DeleteRule`.
24///
25/// <p>Deletes the specified rule.</p>
26/// <p>Before you can delete the rule, you must remove all targets, using <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html">RemoveTargets</a>.</p>
27/// <p>When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.</p>
28/// <p>If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, <code>ResourceNotFoundException</code> is returned.</p>
29/// <p>Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the <code>Force</code> option, but you should do so only if you are sure the other service is not still using that rule.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct DeleteRuleFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::delete_rule::builders::DeleteRuleInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::delete_rule::DeleteRuleOutput,
39        crate::operation::delete_rule::DeleteRuleError,
40    > for DeleteRuleFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::delete_rule::DeleteRuleOutput,
48            crate::operation::delete_rule::DeleteRuleError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl DeleteRuleFluentBuilder {
55    /// Creates a new `DeleteRuleFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the DeleteRule as a reference.
64    pub fn as_input(&self) -> &crate::operation::delete_rule::builders::DeleteRuleInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::delete_rule::DeleteRuleOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::delete_rule::DeleteRuleError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::delete_rule::DeleteRule::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::delete_rule::DeleteRule::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::delete_rule::DeleteRuleOutput,
101        crate::operation::delete_rule::DeleteRuleError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The name of the rule.</p>
116    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.name(input.into());
118        self
119    }
120    /// <p>The name of the rule.</p>
121    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_name(input);
123        self
124    }
125    /// <p>The name of the rule.</p>
126    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_name()
128    }
129    /// <p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
130    pub fn event_bus_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131        self.inner = self.inner.event_bus_name(input.into());
132        self
133    }
134    /// <p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
135    pub fn set_event_bus_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
136        self.inner = self.inner.set_event_bus_name(input);
137        self
138    }
139    /// <p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
140    pub fn get_event_bus_name(&self) -> &::std::option::Option<::std::string::String> {
141        self.inner.get_event_bus_name()
142    }
143    /// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>
144    pub fn force(mut self, input: bool) -> Self {
145        self.inner = self.inner.force(input);
146        self
147    }
148    /// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>
149    pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
150        self.inner = self.inner.set_force(input);
151        self
152    }
153    /// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>
154    pub fn get_force(&self) -> &::std::option::Option<bool> {
155        self.inner.get_force()
156    }
157}