aws_sdk_ec2/operation/modify_route_server/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::modify_route_server::_modify_route_server_output::ModifyRouteServerOutputBuilder;
3
4pub use crate::operation::modify_route_server::_modify_route_server_input::ModifyRouteServerInputBuilder;
5
6impl crate::operation::modify_route_server::builders::ModifyRouteServerInputBuilder {
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_route_server::ModifyRouteServerOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::modify_route_server::ModifyRouteServerError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.modify_route_server();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ModifyRouteServer`.
24///
25/// <p>Modifies the configuration of an existing route server.</p>
26/// <p>Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.</p>
27/// <p>Route server supports the follow route table types:</p>
28/// <ul>
29/// <li>
30/// <p>VPC route tables not associated with subnets</p></li>
31/// <li>
32/// <p>Subnet route tables</p></li>
33/// <li>
34/// <p>Internet gateway route tables</p></li>
35/// </ul>
36/// <p>Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html">Transit Gateway Connect</a>.</p>
37/// <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>
38#[derive(::std::clone::Clone, ::std::fmt::Debug)]
39pub struct ModifyRouteServerFluentBuilder {
40 handle: ::std::sync::Arc<crate::client::Handle>,
41 inner: crate::operation::modify_route_server::builders::ModifyRouteServerInputBuilder,
42 config_override: ::std::option::Option<crate::config::Builder>,
43}
44impl
45 crate::client::customize::internal::CustomizableSend<
46 crate::operation::modify_route_server::ModifyRouteServerOutput,
47 crate::operation::modify_route_server::ModifyRouteServerError,
48 > for ModifyRouteServerFluentBuilder
49{
50 fn send(
51 self,
52 config_override: crate::config::Builder,
53 ) -> crate::client::customize::internal::BoxFuture<
54 crate::client::customize::internal::SendResult<
55 crate::operation::modify_route_server::ModifyRouteServerOutput,
56 crate::operation::modify_route_server::ModifyRouteServerError,
57 >,
58 > {
59 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
60 }
61}
62impl ModifyRouteServerFluentBuilder {
63 /// Creates a new `ModifyRouteServerFluentBuilder`.
64 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
65 Self {
66 handle,
67 inner: ::std::default::Default::default(),
68 config_override: ::std::option::Option::None,
69 }
70 }
71 /// Access the ModifyRouteServer as a reference.
72 pub fn as_input(&self) -> &crate::operation::modify_route_server::builders::ModifyRouteServerInputBuilder {
73 &self.inner
74 }
75 /// Sends the request and returns the response.
76 ///
77 /// If an error occurs, an `SdkError` will be returned with additional details that
78 /// can be matched against.
79 ///
80 /// By default, any retryable failures will be retried twice. Retry behavior
81 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
82 /// set when configuring the client.
83 pub async fn send(
84 self,
85 ) -> ::std::result::Result<
86 crate::operation::modify_route_server::ModifyRouteServerOutput,
87 ::aws_smithy_runtime_api::client::result::SdkError<
88 crate::operation::modify_route_server::ModifyRouteServerError,
89 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
90 >,
91 > {
92 let input = self
93 .inner
94 .build()
95 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
96 let runtime_plugins = crate::operation::modify_route_server::ModifyRouteServer::operation_runtime_plugins(
97 self.handle.runtime_plugins.clone(),
98 &self.handle.conf,
99 self.config_override,
100 );
101 crate::operation::modify_route_server::ModifyRouteServer::orchestrate(&runtime_plugins, input).await
102 }
103
104 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
105 pub fn customize(
106 self,
107 ) -> crate::client::customize::CustomizableOperation<
108 crate::operation::modify_route_server::ModifyRouteServerOutput,
109 crate::operation::modify_route_server::ModifyRouteServerError,
110 Self,
111 > {
112 crate::client::customize::CustomizableOperation::new(self)
113 }
114 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
115 self.set_config_override(::std::option::Option::Some(config_override.into()));
116 self
117 }
118
119 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
120 self.config_override = config_override;
121 self
122 }
123 /// <p>The ID of the route server to modify.</p>
124 pub fn route_server_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
125 self.inner = self.inner.route_server_id(input.into());
126 self
127 }
128 /// <p>The ID of the route server to modify.</p>
129 pub fn set_route_server_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
130 self.inner = self.inner.set_route_server_id(input);
131 self
132 }
133 /// <p>The ID of the route server to modify.</p>
134 pub fn get_route_server_id(&self) -> &::std::option::Option<::std::string::String> {
135 self.inner.get_route_server_id()
136 }
137 /// <p>Specifies whether to persist routes after all BGP sessions are terminated.</p>
138 /// <ul>
139 /// <li>
140 /// <p>enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.</p></li>
141 /// <li>
142 /// <p>disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.</p></li>
143 /// <li>
144 /// <p>reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.</p></li>
145 /// </ul>
146 pub fn persist_routes(mut self, input: crate::types::RouteServerPersistRoutesAction) -> Self {
147 self.inner = self.inner.persist_routes(input);
148 self
149 }
150 /// <p>Specifies whether to persist routes after all BGP sessions are terminated.</p>
151 /// <ul>
152 /// <li>
153 /// <p>enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.</p></li>
154 /// <li>
155 /// <p>disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.</p></li>
156 /// <li>
157 /// <p>reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.</p></li>
158 /// </ul>
159 pub fn set_persist_routes(mut self, input: ::std::option::Option<crate::types::RouteServerPersistRoutesAction>) -> Self {
160 self.inner = self.inner.set_persist_routes(input);
161 self
162 }
163 /// <p>Specifies whether to persist routes after all BGP sessions are terminated.</p>
164 /// <ul>
165 /// <li>
166 /// <p>enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated.</p></li>
167 /// <li>
168 /// <p>disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated.</p></li>
169 /// <li>
170 /// <p>reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB.</p></li>
171 /// </ul>
172 pub fn get_persist_routes(&self) -> &::std::option::Option<crate::types::RouteServerPersistRoutesAction> {
173 self.inner.get_persist_routes()
174 }
175 /// <p>The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is <code>enabled</code>.</p>
176 /// <p>If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.</p>
177 pub fn persist_routes_duration(mut self, input: i64) -> Self {
178 self.inner = self.inner.persist_routes_duration(input);
179 self
180 }
181 /// <p>The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is <code>enabled</code>.</p>
182 /// <p>If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.</p>
183 pub fn set_persist_routes_duration(mut self, input: ::std::option::Option<i64>) -> Self {
184 self.inner = self.inner.set_persist_routes_duration(input);
185 self
186 }
187 /// <p>The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is <code>enabled</code>.</p>
188 /// <p>If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes.</p>
189 pub fn get_persist_routes_duration(&self) -> &::std::option::Option<i64> {
190 self.inner.get_persist_routes_duration()
191 }
192 /// <p>Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
193 pub fn sns_notifications_enabled(mut self, input: bool) -> Self {
194 self.inner = self.inner.sns_notifications_enabled(input);
195 self
196 }
197 /// <p>Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
198 pub fn set_sns_notifications_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
199 self.inner = self.inner.set_sns_notifications_enabled(input);
200 self
201 }
202 /// <p>Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
203 pub fn get_sns_notifications_enabled(&self) -> &::std::option::Option<bool> {
204 self.inner.get_sns_notifications_enabled()
205 }
206 /// <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>
207 pub fn dry_run(mut self, input: bool) -> Self {
208 self.inner = self.inner.dry_run(input);
209 self
210 }
211 /// <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>
212 pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
213 self.inner = self.inner.set_dry_run(input);
214 self
215 }
216 /// <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>
217 pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
218 self.inner.get_dry_run()
219 }
220}