aws_sdk_ec2/operation/create_ipam_scope/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_ipam_scope::_create_ipam_scope_output::CreateIpamScopeOutputBuilder;
3
4pub use crate::operation::create_ipam_scope::_create_ipam_scope_input::CreateIpamScopeInputBuilder;
5
6impl crate::operation::create_ipam_scope::builders::CreateIpamScopeInputBuilder {
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::create_ipam_scope::CreateIpamScopeOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_ipam_scope::CreateIpamScopeError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_ipam_scope();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateIpamScope`.
24///
25/// <p>Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html">Add a scope</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateIpamScopeFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::create_ipam_scope::builders::CreateIpamScopeInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::create_ipam_scope::CreateIpamScopeOutput,
36 crate::operation::create_ipam_scope::CreateIpamScopeError,
37 > for CreateIpamScopeFluentBuilder
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::create_ipam_scope::CreateIpamScopeOutput,
45 crate::operation::create_ipam_scope::CreateIpamScopeError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl CreateIpamScopeFluentBuilder {
52 /// Creates a new `CreateIpamScopeFluentBuilder`.
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 CreateIpamScope as a reference.
61 pub fn as_input(&self) -> &crate::operation::create_ipam_scope::builders::CreateIpamScopeInputBuilder {
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::create_ipam_scope::CreateIpamScopeOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::create_ipam_scope::CreateIpamScopeError,
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::create_ipam_scope::CreateIpamScope::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::create_ipam_scope::CreateIpamScope::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::create_ipam_scope::CreateIpamScopeOutput,
98 crate::operation::create_ipam_scope::CreateIpamScopeError,
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 for which you're creating this scope.</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 for which you're creating this scope.</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 for which you're creating this scope.</p>
137 pub fn get_ipam_id(&self) -> &::std::option::Option<::std::string::String> {
138 self.inner.get_ipam_id()
139 }
140 /// <p>A description for the scope you're creating.</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>A description for the scope you're creating.</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>A description for the scope you're creating.</p>
151 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
152 self.inner.get_description()
153 }
154 ///
155 /// Appends an item to `TagSpecifications`.
156 ///
157 /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
158 ///
159 /// <p>The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>
160 pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
161 self.inner = self.inner.tag_specifications(input);
162 self
163 }
164 /// <p>The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>
165 pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
166 self.inner = self.inner.set_tag_specifications(input);
167 self
168 }
169 /// <p>The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>
170 pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
171 self.inner.get_tag_specifications()
172 }
173 /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>
174 pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175 self.inner = self.inner.client_token(input.into());
176 self
177 }
178 /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>
179 pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180 self.inner = self.inner.set_client_token(input);
181 self
182 }
183 /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>
184 pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
185 self.inner.get_client_token()
186 }
187 /// <p>The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.</p>
188 /// <p>In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.</p>
189 pub fn external_authority_configuration(mut self, input: crate::types::ExternalAuthorityConfiguration) -> Self {
190 self.inner = self.inner.external_authority_configuration(input);
191 self
192 }
193 /// <p>The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.</p>
194 /// <p>In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.</p>
195 pub fn set_external_authority_configuration(mut self, input: ::std::option::Option<crate::types::ExternalAuthorityConfiguration>) -> Self {
196 self.inner = self.inner.set_external_authority_configuration(input);
197 self
198 }
199 /// <p>The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.</p>
200 /// <p>In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.</p>
201 pub fn get_external_authority_configuration(&self) -> &::std::option::Option<crate::types::ExternalAuthorityConfiguration> {
202 self.inner.get_external_authority_configuration()
203 }
204}