aws_sdk_ec2/operation/modify_ipam_pool/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::modify_ipam_pool::_modify_ipam_pool_output::ModifyIpamPoolOutputBuilder;
3
4pub use crate::operation::modify_ipam_pool::_modify_ipam_pool_input::ModifyIpamPoolInputBuilder;
5
6impl crate::operation::modify_ipam_pool::builders::ModifyIpamPoolInputBuilder {
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::modify_ipam_pool::ModifyIpamPoolOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::modify_ipam_pool::ModifyIpamPoolError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.modify_ipam_pool();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ModifyIpamPool`.
24///
25/// <p>Modify the configurations of an IPAM pool.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html">Modify a pool</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ModifyIpamPoolFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::modify_ipam_pool::builders::ModifyIpamPoolInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::modify_ipam_pool::ModifyIpamPoolOutput,
36        crate::operation::modify_ipam_pool::ModifyIpamPoolError,
37    > for ModifyIpamPoolFluentBuilder
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::modify_ipam_pool::ModifyIpamPoolOutput,
45            crate::operation::modify_ipam_pool::ModifyIpamPoolError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ModifyIpamPoolFluentBuilder {
52    /// Creates a new `ModifyIpamPoolFluentBuilder`.
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 ModifyIpamPool as a reference.
61    pub fn as_input(&self) -> &crate::operation::modify_ipam_pool::builders::ModifyIpamPoolInputBuilder {
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::modify_ipam_pool::ModifyIpamPoolOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::modify_ipam_pool::ModifyIpamPoolError,
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::modify_ipam_pool::ModifyIpamPool::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::modify_ipam_pool::ModifyIpamPool::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::modify_ipam_pool::ModifyIpamPoolOutput,
98        crate::operation::modify_ipam_pool::ModifyIpamPoolError,
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 pool you want to modify.</p>
127    pub fn ipam_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.ipam_pool_id(input.into());
129        self
130    }
131    /// <p>The ID of the IPAM pool you want to modify.</p>
132    pub fn set_ipam_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_ipam_pool_id(input);
134        self
135    }
136    /// <p>The ID of the IPAM pool you want to modify.</p>
137    pub fn get_ipam_pool_id(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_ipam_pool_id()
139    }
140    /// <p>The description of the IPAM pool you want to modify.</p>
141    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.description(input.into());
143        self
144    }
145    /// <p>The description of the IPAM pool you want to modify.</p>
146    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_description(input);
148        self
149    }
150    /// <p>The description of the IPAM pool you want to modify.</p>
151    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_description()
153    }
154    /// <p>If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.</p>
155    /// <p>A locale must be set on the pool for this feature to work.</p>
156    pub fn auto_import(mut self, input: bool) -> Self {
157        self.inner = self.inner.auto_import(input);
158        self
159    }
160    /// <p>If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.</p>
161    /// <p>A locale must be set on the pool for this feature to work.</p>
162    pub fn set_auto_import(mut self, input: ::std::option::Option<bool>) -> Self {
163        self.inner = self.inner.set_auto_import(input);
164        self
165    }
166    /// <p>If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.</p>
167    /// <p>A locale must be set on the pool for this feature to work.</p>
168    pub fn get_auto_import(&self) -> &::std::option::Option<bool> {
169        self.inner.get_auto_import()
170    }
171    /// <p>The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.</p>
172    pub fn allocation_min_netmask_length(mut self, input: i32) -> Self {
173        self.inner = self.inner.allocation_min_netmask_length(input);
174        self
175    }
176    /// <p>The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.</p>
177    pub fn set_allocation_min_netmask_length(mut self, input: ::std::option::Option<i32>) -> Self {
178        self.inner = self.inner.set_allocation_min_netmask_length(input);
179        self
180    }
181    /// <p>The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.</p>
182    pub fn get_allocation_min_netmask_length(&self) -> &::std::option::Option<i32> {
183        self.inner.get_allocation_min_netmask_length()
184    }
185    /// <p>The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.</p>
186    pub fn allocation_max_netmask_length(mut self, input: i32) -> Self {
187        self.inner = self.inner.allocation_max_netmask_length(input);
188        self
189    }
190    /// <p>The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.</p>
191    pub fn set_allocation_max_netmask_length(mut self, input: ::std::option::Option<i32>) -> Self {
192        self.inner = self.inner.set_allocation_max_netmask_length(input);
193        self
194    }
195    /// <p>The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.</p>
196    pub fn get_allocation_max_netmask_length(&self) -> &::std::option::Option<i32> {
197        self.inner.get_allocation_max_netmask_length()
198    }
199    /// <p>The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.</p>
200    pub fn allocation_default_netmask_length(mut self, input: i32) -> Self {
201        self.inner = self.inner.allocation_default_netmask_length(input);
202        self
203    }
204    /// <p>The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.</p>
205    pub fn set_allocation_default_netmask_length(mut self, input: ::std::option::Option<i32>) -> Self {
206        self.inner = self.inner.set_allocation_default_netmask_length(input);
207        self
208    }
209    /// <p>The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.</p>
210    pub fn get_allocation_default_netmask_length(&self) -> &::std::option::Option<i32> {
211        self.inner.get_allocation_default_netmask_length()
212    }
213    /// <p>Clear the default netmask length allocation rule for this pool.</p>
214    pub fn clear_allocation_default_netmask_length(mut self, input: bool) -> Self {
215        self.inner = self.inner.clear_allocation_default_netmask_length(input);
216        self
217    }
218    /// <p>Clear the default netmask length allocation rule for this pool.</p>
219    pub fn set_clear_allocation_default_netmask_length(mut self, input: ::std::option::Option<bool>) -> Self {
220        self.inner = self.inner.set_clear_allocation_default_netmask_length(input);
221        self
222    }
223    /// <p>Clear the default netmask length allocation rule for this pool.</p>
224    pub fn get_clear_allocation_default_netmask_length(&self) -> &::std::option::Option<bool> {
225        self.inner.get_clear_allocation_default_netmask_length()
226    }
227    ///
228    /// Appends an item to `AddAllocationResourceTags`.
229    ///
230    /// To override the contents of this collection use [`set_add_allocation_resource_tags`](Self::set_add_allocation_resource_tags).
231    ///
232    /// <p>Add tag allocation rules to a pool. For more information about allocation rules, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html">Create a top-level pool</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>
233    pub fn add_allocation_resource_tags(mut self, input: crate::types::RequestIpamResourceTag) -> Self {
234        self.inner = self.inner.add_allocation_resource_tags(input);
235        self
236    }
237    /// <p>Add tag allocation rules to a pool. For more information about allocation rules, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html">Create a top-level pool</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>
238    pub fn set_add_allocation_resource_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RequestIpamResourceTag>>) -> Self {
239        self.inner = self.inner.set_add_allocation_resource_tags(input);
240        self
241    }
242    /// <p>Add tag allocation rules to a pool. For more information about allocation rules, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html">Create a top-level pool</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>
243    pub fn get_add_allocation_resource_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RequestIpamResourceTag>> {
244        self.inner.get_add_allocation_resource_tags()
245    }
246    ///
247    /// Appends an item to `RemoveAllocationResourceTags`.
248    ///
249    /// To override the contents of this collection use [`set_remove_allocation_resource_tags`](Self::set_remove_allocation_resource_tags).
250    ///
251    /// <p>Remove tag allocation rules from a pool.</p>
252    pub fn remove_allocation_resource_tags(mut self, input: crate::types::RequestIpamResourceTag) -> Self {
253        self.inner = self.inner.remove_allocation_resource_tags(input);
254        self
255    }
256    /// <p>Remove tag allocation rules from a pool.</p>
257    pub fn set_remove_allocation_resource_tags(
258        mut self,
259        input: ::std::option::Option<::std::vec::Vec<crate::types::RequestIpamResourceTag>>,
260    ) -> Self {
261        self.inner = self.inner.set_remove_allocation_resource_tags(input);
262        self
263    }
264    /// <p>Remove tag allocation rules from a pool.</p>
265    pub fn get_remove_allocation_resource_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RequestIpamResourceTag>> {
266        self.inner.get_remove_allocation_resource_tags()
267    }
268}