aws_sdk_ec2/operation/delete_ipam/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_ipam::_delete_ipam_output::DeleteIpamOutputBuilder;
3
4pub use crate::operation::delete_ipam::_delete_ipam_input::DeleteIpamInputBuilder;
5
6impl crate::operation::delete_ipam::builders::DeleteIpamInputBuilder {
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_ipam::DeleteIpamOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::delete_ipam::DeleteIpamError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.delete_ipam();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DeleteIpam`.
24///
25/// <p>Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html">Delete an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DeleteIpamFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::delete_ipam::builders::DeleteIpamInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::delete_ipam::DeleteIpamOutput,
36        crate::operation::delete_ipam::DeleteIpamError,
37    > for DeleteIpamFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::delete_ipam::DeleteIpamOutput,
45            crate::operation::delete_ipam::DeleteIpamError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DeleteIpamFluentBuilder {
52    /// Creates a new `DeleteIpamFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the DeleteIpam as a reference.
61    pub fn as_input(&self) -> &crate::operation::delete_ipam::builders::DeleteIpamInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::delete_ipam::DeleteIpamOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::delete_ipam::DeleteIpamError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::delete_ipam::DeleteIpam::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::delete_ipam::DeleteIpam::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::delete_ipam::DeleteIpamOutput,
98        crate::operation::delete_ipam::DeleteIpamError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
113    pub fn dry_run(mut self, input: bool) -> Self {
114        self.inner = self.inner.dry_run(input);
115        self
116    }
117    /// <p>A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
118    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
119        self.inner = self.inner.set_dry_run(input);
120        self
121    }
122    /// <p>A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
123    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
124        self.inner.get_dry_run()
125    }
126    /// <p>The ID of the IPAM to delete.</p>
127    pub fn ipam_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.ipam_id(input.into());
129        self
130    }
131    /// <p>The ID of the IPAM to delete.</p>
132    pub fn set_ipam_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_ipam_id(input);
134        self
135    }
136    /// <p>The ID of the IPAM to delete.</p>
137    pub fn get_ipam_id(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_ipam_id()
139    }
140    /// <p>Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:</p>
141    /// <ul>
142    /// <li>
143    /// <p>Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.</p><note>
144    /// <p>No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.</p>
145    /// </note></li>
146    /// <li>
147    /// <p>Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.</p></li>
148    /// <li>
149    /// <p>Deletes all IPAM pools in private scopes.</p></li>
150    /// <li>
151    /// <p>Deletes all non-default private scopes in the IPAM.</p></li>
152    /// <li>
153    /// <p>Deletes the default public and private scopes and the IPAM.</p></li>
154    /// </ul>
155    pub fn cascade(mut self, input: bool) -> Self {
156        self.inner = self.inner.cascade(input);
157        self
158    }
159    /// <p>Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:</p>
160    /// <ul>
161    /// <li>
162    /// <p>Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.</p><note>
163    /// <p>No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.</p>
164    /// </note></li>
165    /// <li>
166    /// <p>Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.</p></li>
167    /// <li>
168    /// <p>Deletes all IPAM pools in private scopes.</p></li>
169    /// <li>
170    /// <p>Deletes all non-default private scopes in the IPAM.</p></li>
171    /// <li>
172    /// <p>Deletes the default public and private scopes and the IPAM.</p></li>
173    /// </ul>
174    pub fn set_cascade(mut self, input: ::std::option::Option<bool>) -> Self {
175        self.inner = self.inner.set_cascade(input);
176        self
177    }
178    /// <p>Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:</p>
179    /// <ul>
180    /// <li>
181    /// <p>Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.</p><note>
182    /// <p>No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.</p>
183    /// </note></li>
184    /// <li>
185    /// <p>Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.</p></li>
186    /// <li>
187    /// <p>Deletes all IPAM pools in private scopes.</p></li>
188    /// <li>
189    /// <p>Deletes all non-default private scopes in the IPAM.</p></li>
190    /// <li>
191    /// <p>Deletes the default public and private scopes and the IPAM.</p></li>
192    /// </ul>
193    pub fn get_cascade(&self) -> &::std::option::Option<bool> {
194        self.inner.get_cascade()
195    }
196}