aws_sdk_firehose/operation/delete_delivery_stream/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_delivery_stream::_delete_delivery_stream_output::DeleteDeliveryStreamOutputBuilder;
3
4pub use crate::operation::delete_delivery_stream::_delete_delivery_stream_input::DeleteDeliveryStreamInputBuilder;
5
6impl crate::operation::delete_delivery_stream::builders::DeleteDeliveryStreamInputBuilder {
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_delivery_stream::DeleteDeliveryStreamOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_delivery_stream::DeleteDeliveryStreamError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_delivery_stream();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeleteDeliveryStream`.
24///
25/// <p>Deletes a Firehose stream and its data.</p>
26/// <p>You can delete a Firehose stream only if it is in one of the following states: <code>ACTIVE</code>, <code>DELETING</code>, <code>CREATING_FAILED</code>, or <code>DELETING_FAILED</code>. You can't delete a Firehose stream that is in the <code>CREATING</code> state. To check the state of a Firehose stream, use <code>DescribeDeliveryStream</code>.</p>
27/// <p>DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose stream is marked for deletion, and it goes into the <code>DELETING</code> state.While the Firehose stream is in the <code>DELETING</code> state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a Firehose stream.</p>
28/// <p>Removal of a Firehose stream that is in the <code>DELETING</code> state is a low priority operation for the service. A stream may remain in the <code>DELETING</code> state for several minutes. Therefore, as a best practice, applications should not wait for streams in the <code>DELETING</code> state to be removed.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct DeleteDeliveryStreamFluentBuilder {
31 handle: ::std::sync::Arc<crate::client::Handle>,
32 inner: crate::operation::delete_delivery_stream::builders::DeleteDeliveryStreamInputBuilder,
33 config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36 crate::client::customize::internal::CustomizableSend<
37 crate::operation::delete_delivery_stream::DeleteDeliveryStreamOutput,
38 crate::operation::delete_delivery_stream::DeleteDeliveryStreamError,
39 > for DeleteDeliveryStreamFluentBuilder
40{
41 fn send(
42 self,
43 config_override: crate::config::Builder,
44 ) -> crate::client::customize::internal::BoxFuture<
45 crate::client::customize::internal::SendResult<
46 crate::operation::delete_delivery_stream::DeleteDeliveryStreamOutput,
47 crate::operation::delete_delivery_stream::DeleteDeliveryStreamError,
48 >,
49 > {
50 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51 }
52}
53impl DeleteDeliveryStreamFluentBuilder {
54 /// Creates a new `DeleteDeliveryStreamFluentBuilder`.
55 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56 Self {
57 handle,
58 inner: ::std::default::Default::default(),
59 config_override: ::std::option::Option::None,
60 }
61 }
62 /// Access the DeleteDeliveryStream as a reference.
63 pub fn as_input(&self) -> &crate::operation::delete_delivery_stream::builders::DeleteDeliveryStreamInputBuilder {
64 &self.inner
65 }
66 /// Sends the request and returns the response.
67 ///
68 /// If an error occurs, an `SdkError` will be returned with additional details that
69 /// can be matched against.
70 ///
71 /// By default, any retryable failures will be retried twice. Retry behavior
72 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73 /// set when configuring the client.
74 pub async fn send(
75 self,
76 ) -> ::std::result::Result<
77 crate::operation::delete_delivery_stream::DeleteDeliveryStreamOutput,
78 ::aws_smithy_runtime_api::client::result::SdkError<
79 crate::operation::delete_delivery_stream::DeleteDeliveryStreamError,
80 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81 >,
82 > {
83 let input = self
84 .inner
85 .build()
86 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87 let runtime_plugins = crate::operation::delete_delivery_stream::DeleteDeliveryStream::operation_runtime_plugins(
88 self.handle.runtime_plugins.clone(),
89 &self.handle.conf,
90 self.config_override,
91 );
92 crate::operation::delete_delivery_stream::DeleteDeliveryStream::orchestrate(&runtime_plugins, input).await
93 }
94
95 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96 pub fn customize(
97 self,
98 ) -> crate::client::customize::CustomizableOperation<
99 crate::operation::delete_delivery_stream::DeleteDeliveryStreamOutput,
100 crate::operation::delete_delivery_stream::DeleteDeliveryStreamError,
101 Self,
102 > {
103 crate::client::customize::CustomizableOperation::new(self)
104 }
105 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106 self.set_config_override(::std::option::Option::Some(config_override.into()));
107 self
108 }
109
110 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111 self.config_override = config_override;
112 self
113 }
114 /// <p>The name of the Firehose stream.</p>
115 pub fn delivery_stream_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116 self.inner = self.inner.delivery_stream_name(input.into());
117 self
118 }
119 /// <p>The name of the Firehose stream.</p>
120 pub fn set_delivery_stream_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121 self.inner = self.inner.set_delivery_stream_name(input);
122 self
123 }
124 /// <p>The name of the Firehose stream.</p>
125 pub fn get_delivery_stream_name(&self) -> &::std::option::Option<::std::string::String> {
126 self.inner.get_delivery_stream_name()
127 }
128 /// <p>Set this to true if you want to delete the Firehose stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation.</p>
129 /// <p>The default value is false.</p>
130 pub fn allow_force_delete(mut self, input: bool) -> Self {
131 self.inner = self.inner.allow_force_delete(input);
132 self
133 }
134 /// <p>Set this to true if you want to delete the Firehose stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation.</p>
135 /// <p>The default value is false.</p>
136 pub fn set_allow_force_delete(mut self, input: ::std::option::Option<bool>) -> Self {
137 self.inner = self.inner.set_allow_force_delete(input);
138 self
139 }
140 /// <p>Set this to true if you want to delete the Firehose stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation.</p>
141 /// <p>The default value is false.</p>
142 pub fn get_allow_force_delete(&self) -> &::std::option::Option<bool> {
143 self.inner.get_allow_force_delete()
144 }
145}