aws_sdk_ec2/operation/create_route_server/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_route_server::_create_route_server_output::CreateRouteServerOutputBuilder;
3
4pub use crate::operation::create_route_server::_create_route_server_input::CreateRouteServerInputBuilder;
5
6impl crate::operation::create_route_server::builders::CreateRouteServerInputBuilder {
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_route_server::CreateRouteServerOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_route_server::CreateRouteServerError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_route_server();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateRouteServer`.
24///
25/// <p>Creates a new route server to manage dynamic routing in a VPC.</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 CreateRouteServerFluentBuilder {
40    handle: ::std::sync::Arc<crate::client::Handle>,
41    inner: crate::operation::create_route_server::builders::CreateRouteServerInputBuilder,
42    config_override: ::std::option::Option<crate::config::Builder>,
43}
44impl
45    crate::client::customize::internal::CustomizableSend<
46        crate::operation::create_route_server::CreateRouteServerOutput,
47        crate::operation::create_route_server::CreateRouteServerError,
48    > for CreateRouteServerFluentBuilder
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::create_route_server::CreateRouteServerOutput,
56            crate::operation::create_route_server::CreateRouteServerError,
57        >,
58    > {
59        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
60    }
61}
62impl CreateRouteServerFluentBuilder {
63    /// Creates a new `CreateRouteServerFluentBuilder`.
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 CreateRouteServer as a reference.
72    pub fn as_input(&self) -> &crate::operation::create_route_server::builders::CreateRouteServerInputBuilder {
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::create_route_server::CreateRouteServerOutput,
87        ::aws_smithy_runtime_api::client::result::SdkError<
88            crate::operation::create_route_server::CreateRouteServerError,
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::create_route_server::CreateRouteServer::operation_runtime_plugins(
97            self.handle.runtime_plugins.clone(),
98            &self.handle.conf,
99            self.config_override,
100        );
101        crate::operation::create_route_server::CreateRouteServer::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::create_route_server::CreateRouteServerOutput,
109        crate::operation::create_route_server::CreateRouteServerError,
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 private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.</p>
124    pub fn amazon_side_asn(mut self, input: i64) -> Self {
125        self.inner = self.inner.amazon_side_asn(input);
126        self
127    }
128    /// <p>The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.</p>
129    pub fn set_amazon_side_asn(mut self, input: ::std::option::Option<i64>) -> Self {
130        self.inner = self.inner.set_amazon_side_asn(input);
131        self
132    }
133    /// <p>The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.</p>
134    pub fn get_amazon_side_asn(&self) -> &::std::option::Option<i64> {
135        self.inner.get_amazon_side_asn()
136    }
137    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
138    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
139        self.inner = self.inner.client_token(input.into());
140        self
141    }
142    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
143    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
144        self.inner = self.inner.set_client_token(input);
145        self
146    }
147    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
148    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
149        self.inner.get_client_token()
150    }
151    /// <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>
152    pub fn dry_run(mut self, input: bool) -> Self {
153        self.inner = self.inner.dry_run(input);
154        self
155    }
156    /// <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>
157    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
158        self.inner = self.inner.set_dry_run(input);
159        self
160    }
161    /// <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>
162    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
163        self.inner.get_dry_run()
164    }
165    /// <p>Indicates whether routes should be persisted after all BGP sessions are terminated.</p>
166    pub fn persist_routes(mut self, input: crate::types::RouteServerPersistRoutesAction) -> Self {
167        self.inner = self.inner.persist_routes(input);
168        self
169    }
170    /// <p>Indicates whether routes should be persisted after all BGP sessions are terminated.</p>
171    pub fn set_persist_routes(mut self, input: ::std::option::Option<crate::types::RouteServerPersistRoutesAction>) -> Self {
172        self.inner = self.inner.set_persist_routes(input);
173        self
174    }
175    /// <p>Indicates whether routes should be persisted after all BGP sessions are terminated.</p>
176    pub fn get_persist_routes(&self) -> &::std::option::Option<crate::types::RouteServerPersistRoutesAction> {
177        self.inner.get_persist_routes()
178    }
179    /// <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>
180    /// <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>
181    pub fn persist_routes_duration(mut self, input: i64) -> Self {
182        self.inner = self.inner.persist_routes_duration(input);
183        self
184    }
185    /// <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>
186    /// <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>
187    pub fn set_persist_routes_duration(mut self, input: ::std::option::Option<i64>) -> Self {
188        self.inner = self.inner.set_persist_routes_duration(input);
189        self
190    }
191    /// <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>
192    /// <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>
193    pub fn get_persist_routes_duration(&self) -> &::std::option::Option<i64> {
194        self.inner.get_persist_routes_duration()
195    }
196    /// <p>Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
197    pub fn sns_notifications_enabled(mut self, input: bool) -> Self {
198        self.inner = self.inner.sns_notifications_enabled(input);
199        self
200    }
201    /// <p>Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
202    pub fn set_sns_notifications_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
203        self.inner = self.inner.set_sns_notifications_enabled(input);
204        self
205    }
206    /// <p>Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.</p>
207    pub fn get_sns_notifications_enabled(&self) -> &::std::option::Option<bool> {
208        self.inner.get_sns_notifications_enabled()
209    }
210    ///
211    /// Appends an item to `TagSpecifications`.
212    ///
213    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
214    ///
215    /// <p>The tags to apply to the route server during creation.</p>
216    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
217        self.inner = self.inner.tag_specifications(input);
218        self
219    }
220    /// <p>The tags to apply to the route server during creation.</p>
221    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
222        self.inner = self.inner.set_tag_specifications(input);
223        self
224    }
225    /// <p>The tags to apply to the route server during creation.</p>
226    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
227        self.inner.get_tag_specifications()
228    }
229}