aws_sdk_ec2/operation/get_ipam_policy_allocation_rules/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_ipam_policy_allocation_rules::_get_ipam_policy_allocation_rules_output::GetIpamPolicyAllocationRulesOutputBuilder;
3
4pub use crate::operation::get_ipam_policy_allocation_rules::_get_ipam_policy_allocation_rules_input::GetIpamPolicyAllocationRulesInputBuilder;
5
6impl crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesInputBuilder {
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::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_ipam_policy_allocation_rules();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetIpamPolicyAllocationRules`.
24///
25/// <p>Gets the allocation rules for an IPAM policy.</p>
26/// <p>An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.</p>
27/// <p>Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetIpamPolicyAllocationRulesFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput,
37        crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesError,
38    > for GetIpamPolicyAllocationRulesFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput,
46            crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetIpamPolicyAllocationRulesFluentBuilder {
53    /// Creates a new `GetIpamPolicyAllocationRulesFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the GetIpamPolicyAllocationRules as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_ipam_policy_allocation_rules::builders::GetIpamPolicyAllocationRulesInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRules::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRules::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesOutput,
99        crate::operation::get_ipam_policy_allocation_rules::GetIpamPolicyAllocationRulesError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <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>
114    pub fn dry_run(mut self, input: bool) -> Self {
115        self.inner = self.inner.dry_run(input);
116        self
117    }
118    /// <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>
119    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
120        self.inner = self.inner.set_dry_run(input);
121        self
122    }
123    /// <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>
124    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
125        self.inner.get_dry_run()
126    }
127    /// <p>The ID of the IPAM policy for which to get allocation rules.</p>
128    pub fn ipam_policy_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.ipam_policy_id(input.into());
130        self
131    }
132    /// <p>The ID of the IPAM policy for which to get allocation rules.</p>
133    pub fn set_ipam_policy_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134        self.inner = self.inner.set_ipam_policy_id(input);
135        self
136    }
137    /// <p>The ID of the IPAM policy for which to get allocation rules.</p>
138    pub fn get_ipam_policy_id(&self) -> &::std::option::Option<::std::string::String> {
139        self.inner.get_ipam_policy_id()
140    }
141    ///
142    /// Appends an item to `Filters`.
143    ///
144    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
145    ///
146    /// <p>One or more filters for the allocation rules.</p>
147    pub fn filters(mut self, input: crate::types::Filter) -> Self {
148        self.inner = self.inner.filters(input);
149        self
150    }
151    /// <p>One or more filters for the allocation rules.</p>
152    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
153        self.inner = self.inner.set_filters(input);
154        self
155    }
156    /// <p>One or more filters for the allocation rules.</p>
157    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
158        self.inner.get_filters()
159    }
160    /// <p>The locale for which to get the allocation rules.</p>
161    pub fn locale(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
162        self.inner = self.inner.locale(input.into());
163        self
164    }
165    /// <p>The locale for which to get the allocation rules.</p>
166    pub fn set_locale(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
167        self.inner = self.inner.set_locale(input);
168        self
169    }
170    /// <p>The locale for which to get the allocation rules.</p>
171    pub fn get_locale(&self) -> &::std::option::Option<::std::string::String> {
172        self.inner.get_locale()
173    }
174    /// <p>The resource type for which to get the allocation rules.</p>
175    /// <p>The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:</p>
176    /// <ul>
177    /// <li>
178    /// <p>Elastic IP addresses</p></li>
179    /// </ul>
180    pub fn resource_type(mut self, input: crate::types::IpamPolicyResourceType) -> Self {
181        self.inner = self.inner.resource_type(input);
182        self
183    }
184    /// <p>The resource type for which to get the allocation rules.</p>
185    /// <p>The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:</p>
186    /// <ul>
187    /// <li>
188    /// <p>Elastic IP addresses</p></li>
189    /// </ul>
190    pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::IpamPolicyResourceType>) -> Self {
191        self.inner = self.inner.set_resource_type(input);
192        self
193    }
194    /// <p>The resource type for which to get the allocation rules.</p>
195    /// <p>The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:</p>
196    /// <ul>
197    /// <li>
198    /// <p>Elastic IP addresses</p></li>
199    /// </ul>
200    pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::IpamPolicyResourceType> {
201        self.inner.get_resource_type()
202    }
203    /// <p>The maximum number of results to return in a single call.</p>
204    pub fn max_results(mut self, input: i32) -> Self {
205        self.inner = self.inner.max_results(input);
206        self
207    }
208    /// <p>The maximum number of results to return in a single call.</p>
209    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
210        self.inner = self.inner.set_max_results(input);
211        self
212    }
213    /// <p>The maximum number of results to return in a single call.</p>
214    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
215        self.inner.get_max_results()
216    }
217    /// <p>The token for the next page of results.</p>
218    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
219        self.inner = self.inner.next_token(input.into());
220        self
221    }
222    /// <p>The token for the next page of results.</p>
223    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
224        self.inner = self.inner.set_next_token(input);
225        self
226    }
227    /// <p>The token for the next page of results.</p>
228    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
229        self.inner.get_next_token()
230    }
231}