aws_sdk_ec2/operation/create_nat_gateway/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_nat_gateway::_create_nat_gateway_output::CreateNatGatewayOutputBuilder;
3
4pub use crate::operation::create_nat_gateway::_create_nat_gateway_input::CreateNatGatewayInputBuilder;
5
6impl crate::operation::create_nat_gateway::builders::CreateNatGatewayInputBuilder {
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_nat_gateway::CreateNatGatewayOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_nat_gateway::CreateNatGatewayError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_nat_gateway();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateNatGateway`.
24///
25/// <p>Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.</p>
26/// <p>With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.</p>
27/// <p>With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.</p>
28/// <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html">NAT gateways</a> in the <i>Amazon VPC User Guide</i>.</p><important>
29/// <p>When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html">Allocate an Elastic IP address</a> in the <i>Amazon VPC User Guide</i>.</p>
30/// </important>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct CreateNatGatewayFluentBuilder {
33 handle: ::std::sync::Arc<crate::client::Handle>,
34 inner: crate::operation::create_nat_gateway::builders::CreateNatGatewayInputBuilder,
35 config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38 crate::client::customize::internal::CustomizableSend<
39 crate::operation::create_nat_gateway::CreateNatGatewayOutput,
40 crate::operation::create_nat_gateway::CreateNatGatewayError,
41 > for CreateNatGatewayFluentBuilder
42{
43 fn send(
44 self,
45 config_override: crate::config::Builder,
46 ) -> crate::client::customize::internal::BoxFuture<
47 crate::client::customize::internal::SendResult<
48 crate::operation::create_nat_gateway::CreateNatGatewayOutput,
49 crate::operation::create_nat_gateway::CreateNatGatewayError,
50 >,
51 > {
52 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53 }
54}
55impl CreateNatGatewayFluentBuilder {
56 /// Creates a new `CreateNatGatewayFluentBuilder`.
57 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58 Self {
59 handle,
60 inner: ::std::default::Default::default(),
61 config_override: ::std::option::Option::None,
62 }
63 }
64 /// Access the CreateNatGateway as a reference.
65 pub fn as_input(&self) -> &crate::operation::create_nat_gateway::builders::CreateNatGatewayInputBuilder {
66 &self.inner
67 }
68 /// Sends the request and returns the response.
69 ///
70 /// If an error occurs, an `SdkError` will be returned with additional details that
71 /// can be matched against.
72 ///
73 /// By default, any retryable failures will be retried twice. Retry behavior
74 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75 /// set when configuring the client.
76 pub async fn send(
77 self,
78 ) -> ::std::result::Result<
79 crate::operation::create_nat_gateway::CreateNatGatewayOutput,
80 ::aws_smithy_runtime_api::client::result::SdkError<
81 crate::operation::create_nat_gateway::CreateNatGatewayError,
82 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83 >,
84 > {
85 let input = self
86 .inner
87 .build()
88 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89 let runtime_plugins = crate::operation::create_nat_gateway::CreateNatGateway::operation_runtime_plugins(
90 self.handle.runtime_plugins.clone(),
91 &self.handle.conf,
92 self.config_override,
93 );
94 crate::operation::create_nat_gateway::CreateNatGateway::orchestrate(&runtime_plugins, input).await
95 }
96
97 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98 pub fn customize(
99 self,
100 ) -> crate::client::customize::CustomizableOperation<
101 crate::operation::create_nat_gateway::CreateNatGatewayOutput,
102 crate::operation::create_nat_gateway::CreateNatGatewayError,
103 Self,
104 > {
105 crate::client::customize::CustomizableOperation::new(self)
106 }
107 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108 self.set_config_override(::std::option::Option::Some(config_override.into()));
109 self
110 }
111
112 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113 self.config_override = config_override;
114 self
115 }
116 /// <p>\[Public NAT gateways only\] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.</p>
117 pub fn allocation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118 self.inner = self.inner.allocation_id(input.into());
119 self
120 }
121 /// <p>\[Public NAT gateways only\] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.</p>
122 pub fn set_allocation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123 self.inner = self.inner.set_allocation_id(input);
124 self
125 }
126 /// <p>\[Public NAT gateways only\] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.</p>
127 pub fn get_allocation_id(&self) -> &::std::option::Option<::std::string::String> {
128 self.inner.get_allocation_id()
129 }
130 /// <p>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>
131 /// <p>Constraint: Maximum 64 ASCII characters.</p>
132 pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133 self.inner = self.inner.client_token(input.into());
134 self
135 }
136 /// <p>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>
137 /// <p>Constraint: Maximum 64 ASCII characters.</p>
138 pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139 self.inner = self.inner.set_client_token(input);
140 self
141 }
142 /// <p>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>
143 /// <p>Constraint: Maximum 64 ASCII characters.</p>
144 pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
145 self.inner.get_client_token()
146 }
147 /// <p>Checks 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>
148 pub fn dry_run(mut self, input: bool) -> Self {
149 self.inner = self.inner.dry_run(input);
150 self
151 }
152 /// <p>Checks 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>
153 pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
154 self.inner = self.inner.set_dry_run(input);
155 self
156 }
157 /// <p>Checks 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>
158 pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
159 self.inner.get_dry_run()
160 }
161 /// <p>The ID of the subnet in which to create the NAT gateway.</p>
162 pub fn subnet_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
163 self.inner = self.inner.subnet_id(input.into());
164 self
165 }
166 /// <p>The ID of the subnet in which to create the NAT gateway.</p>
167 pub fn set_subnet_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
168 self.inner = self.inner.set_subnet_id(input);
169 self
170 }
171 /// <p>The ID of the subnet in which to create the NAT gateway.</p>
172 pub fn get_subnet_id(&self) -> &::std::option::Option<::std::string::String> {
173 self.inner.get_subnet_id()
174 }
175 ///
176 /// Appends an item to `TagSpecifications`.
177 ///
178 /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
179 ///
180 /// <p>The tags to assign to the NAT gateway.</p>
181 pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
182 self.inner = self.inner.tag_specifications(input);
183 self
184 }
185 /// <p>The tags to assign to the NAT gateway.</p>
186 pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
187 self.inner = self.inner.set_tag_specifications(input);
188 self
189 }
190 /// <p>The tags to assign to the NAT gateway.</p>
191 pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
192 self.inner.get_tag_specifications()
193 }
194 /// <p>Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.</p>
195 pub fn connectivity_type(mut self, input: crate::types::ConnectivityType) -> Self {
196 self.inner = self.inner.connectivity_type(input);
197 self
198 }
199 /// <p>Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.</p>
200 pub fn set_connectivity_type(mut self, input: ::std::option::Option<crate::types::ConnectivityType>) -> Self {
201 self.inner = self.inner.set_connectivity_type(input);
202 self
203 }
204 /// <p>Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.</p>
205 pub fn get_connectivity_type(&self) -> &::std::option::Option<crate::types::ConnectivityType> {
206 self.inner.get_connectivity_type()
207 }
208 /// <p>The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.</p>
209 pub fn private_ip_address(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
210 self.inner = self.inner.private_ip_address(input.into());
211 self
212 }
213 /// <p>The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.</p>
214 pub fn set_private_ip_address(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
215 self.inner = self.inner.set_private_ip_address(input);
216 self
217 }
218 /// <p>The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.</p>
219 pub fn get_private_ip_address(&self) -> &::std::option::Option<::std::string::String> {
220 self.inner.get_private_ip_address()
221 }
222 ///
223 /// Appends an item to `SecondaryAllocationIds`.
224 ///
225 /// To override the contents of this collection use [`set_secondary_allocation_ids`](Self::set_secondary_allocation_ids).
226 ///
227 /// <p>Secondary EIP allocation IDs. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
228 pub fn secondary_allocation_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
229 self.inner = self.inner.secondary_allocation_ids(input.into());
230 self
231 }
232 /// <p>Secondary EIP allocation IDs. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
233 pub fn set_secondary_allocation_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
234 self.inner = self.inner.set_secondary_allocation_ids(input);
235 self
236 }
237 /// <p>Secondary EIP allocation IDs. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
238 pub fn get_secondary_allocation_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
239 self.inner.get_secondary_allocation_ids()
240 }
241 ///
242 /// Appends an item to `SecondaryPrivateIpAddresses`.
243 ///
244 /// To override the contents of this collection use [`set_secondary_private_ip_addresses`](Self::set_secondary_private_ip_addresses).
245 ///
246 /// <p>Secondary private IPv4 addresses. For more information about secondary addresses, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
247 pub fn secondary_private_ip_addresses(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
248 self.inner = self.inner.secondary_private_ip_addresses(input.into());
249 self
250 }
251 /// <p>Secondary private IPv4 addresses. For more information about secondary addresses, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
252 pub fn set_secondary_private_ip_addresses(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
253 self.inner = self.inner.set_secondary_private_ip_addresses(input);
254 self
255 }
256 /// <p>Secondary private IPv4 addresses. For more information about secondary addresses, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html">Create a NAT gateway</a> in the <i>Amazon VPC User Guide</i>.</p>
257 pub fn get_secondary_private_ip_addresses(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
258 self.inner.get_secondary_private_ip_addresses()
259 }
260 /// <p>\[Private NAT gateway only\] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.</p>
261 pub fn secondary_private_ip_address_count(mut self, input: i32) -> Self {
262 self.inner = self.inner.secondary_private_ip_address_count(input);
263 self
264 }
265 /// <p>\[Private NAT gateway only\] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.</p>
266 pub fn set_secondary_private_ip_address_count(mut self, input: ::std::option::Option<i32>) -> Self {
267 self.inner = self.inner.set_secondary_private_ip_address_count(input);
268 self
269 }
270 /// <p>\[Private NAT gateway only\] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.</p>
271 pub fn get_secondary_private_ip_address_count(&self) -> &::std::option::Option<i32> {
272 self.inner.get_secondary_private_ip_address_count()
273 }
274}