aws_sdk_transfer/operation/update_server/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_server::_update_server_output::UpdateServerOutputBuilder;
3
4pub use crate::operation::update_server::_update_server_input::UpdateServerInputBuilder;
5
6impl crate::operation::update_server::builders::UpdateServerInputBuilder {
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::update_server::UpdateServerOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_server::UpdateServerError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_server();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateServer`.
24///
25/// <p>Updates the file transfer protocol-enabled server's properties after that server has been created.</p>
26/// <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct UpdateServerFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::update_server::builders::UpdateServerInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::update_server::UpdateServerOutput,
36        crate::operation::update_server::UpdateServerError,
37    > for UpdateServerFluentBuilder
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::update_server::UpdateServerOutput,
45            crate::operation::update_server::UpdateServerError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl UpdateServerFluentBuilder {
52    /// Creates a new `UpdateServerFluentBuilder`.
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 UpdateServer as a reference.
61    pub fn as_input(&self) -> &crate::operation::update_server::builders::UpdateServerInputBuilder {
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::update_server::UpdateServerOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::update_server::UpdateServerError,
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::update_server::UpdateServer::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::update_server::UpdateServer::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::update_server::UpdateServerOutput,
98        crate::operation::update_server::UpdateServerError,
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>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
113    /// <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
114    /// <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
115    /// <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
116    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
117    /// <ul>
118    /// <li>
119    /// <p>2048-bit RSA (RSA_2048)</p></li>
120    /// <li>
121    /// <p>4096-bit RSA (RSA_4096)</p></li>
122    /// <li>
123    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
124    /// <li>
125    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
126    /// <li>
127    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
128    /// </ul><note>
129    /// <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p>
130    /// </note>
131    pub fn certificate(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.certificate(input.into());
133        self
134    }
135    /// <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
136    /// <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
137    /// <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
138    /// <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
139    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
140    /// <ul>
141    /// <li>
142    /// <p>2048-bit RSA (RSA_2048)</p></li>
143    /// <li>
144    /// <p>4096-bit RSA (RSA_4096)</p></li>
145    /// <li>
146    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
147    /// <li>
148    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
149    /// <li>
150    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
151    /// </ul><note>
152    /// <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p>
153    /// </note>
154    pub fn set_certificate(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
155        self.inner = self.inner.set_certificate(input);
156        self
157    }
158    /// <p>The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
159    /// <p>To request a new public certificate, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request a public certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
160    /// <p>To import an existing certificate into ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into ACM</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
161    /// <p>To request a private certificate to use FTPS through private IP addresses, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request a private certificate</a> in the <i> Amazon Web ServicesCertificate Manager User Guide</i>.</p>
162    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
163    /// <ul>
164    /// <li>
165    /// <p>2048-bit RSA (RSA_2048)</p></li>
166    /// <li>
167    /// <p>4096-bit RSA (RSA_4096)</p></li>
168    /// <li>
169    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
170    /// <li>
171    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
172    /// <li>
173    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
174    /// </ul><note>
175    /// <p>The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.</p>
176    /// </note>
177    pub fn get_certificate(&self) -> &::std::option::Option<::std::string::String> {
178        self.inner.get_certificate()
179    }
180    /// <p>The protocol settings that are configured for your server.</p><note>
181    /// <p>Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations"> Avoid placing NLBs and NATs in front of Transfer Family</a>.</p>
182    /// </note>
183    /// <ul>
184    /// <li>
185    /// <p>To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.</p></li>
186    /// <li>
187    /// <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code> call.</p></li>
188    /// <li>
189    /// <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the <code>TlsSessionResumptionMode</code> parameter.</p></li>
190    /// <li>
191    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
192    /// </ul>
193    pub fn protocol_details(mut self, input: crate::types::ProtocolDetails) -> Self {
194        self.inner = self.inner.protocol_details(input);
195        self
196    }
197    /// <p>The protocol settings that are configured for your server.</p><note>
198    /// <p>Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations"> Avoid placing NLBs and NATs in front of Transfer Family</a>.</p>
199    /// </note>
200    /// <ul>
201    /// <li>
202    /// <p>To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.</p></li>
203    /// <li>
204    /// <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code> call.</p></li>
205    /// <li>
206    /// <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the <code>TlsSessionResumptionMode</code> parameter.</p></li>
207    /// <li>
208    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
209    /// </ul>
210    pub fn set_protocol_details(mut self, input: ::std::option::Option<crate::types::ProtocolDetails>) -> Self {
211        self.inner = self.inner.set_protocol_details(input);
212        self
213    }
214    /// <p>The protocol settings that are configured for your server.</p><note>
215    /// <p>Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/infrastructure-security.html#nlb-considerations"> Avoid placing NLBs and NATs in front of Transfer Family</a>.</p>
216    /// </note>
217    /// <ul>
218    /// <li>
219    /// <p>To indicate passive mode (for FTP and FTPS protocols), use the <code>PassiveIp</code> parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.</p></li>
220    /// <li>
221    /// <p>To ignore the error that is generated when the client attempts to use the <code>SETSTAT</code> command on a file that you are uploading to an Amazon S3 bucket, use the <code>SetStatOption</code> parameter. To have the Transfer Family server ignore the <code>SETSTAT</code> command and upload files without needing to make any changes to your SFTP client, set the value to <code>ENABLE_NO_OP</code>. If you set the <code>SetStatOption</code> parameter to <code>ENABLE_NO_OP</code>, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a <code>SETSTAT</code> call.</p></li>
222    /// <li>
223    /// <p>To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the <code>TlsSessionResumptionMode</code> parameter.</p></li>
224    /// <li>
225    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
226    /// </ul>
227    pub fn get_protocol_details(&self) -> &::std::option::Option<crate::types::ProtocolDetails> {
228        self.inner.get_protocol_details()
229    }
230    /// <p>The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.</p>
231    pub fn endpoint_details(mut self, input: crate::types::EndpointDetails) -> Self {
232        self.inner = self.inner.endpoint_details(input);
233        self
234    }
235    /// <p>The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.</p>
236    pub fn set_endpoint_details(mut self, input: ::std::option::Option<crate::types::EndpointDetails>) -> Self {
237        self.inner = self.inner.set_endpoint_details(input);
238        self
239    }
240    /// <p>The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.</p>
241    pub fn get_endpoint_details(&self) -> &::std::option::Option<crate::types::EndpointDetails> {
242        self.inner.get_endpoint_details()
243    }
244    /// <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p><note>
245    /// <p>After May 19, 2021, you won't be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p>
246    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
247    /// <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
248    /// </note>
249    pub fn endpoint_type(mut self, input: crate::types::EndpointType) -> Self {
250        self.inner = self.inner.endpoint_type(input);
251        self
252    }
253    /// <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p><note>
254    /// <p>After May 19, 2021, you won't be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p>
255    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
256    /// <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
257    /// </note>
258    pub fn set_endpoint_type(mut self, input: ::std::option::Option<crate::types::EndpointType>) -> Self {
259        self.inner = self.inner.set_endpoint_type(input);
260        self
261    }
262    /// <p>The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.</p><note>
263    /// <p>After May 19, 2021, you won't be able to create a server using <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers with <code>EndpointType=VPC_ENDPOINT</code> in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, use <code>EndpointType</code>=<code>VPC</code>.</p>
264    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
265    /// <p>It is recommended that you use <code>VPC</code> as the <code>EndpointType</code>. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p>
266    /// </note>
267    pub fn get_endpoint_type(&self) -> &::std::option::Option<crate::types::EndpointType> {
268        self.inner.get_endpoint_type()
269    }
270    /// <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.</p>
271    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
272    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
273    /// <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p>
274    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
275    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
276    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
277    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
278    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
279    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
280    /// <p>If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p>
281    /// </important>
282    /// <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
283    pub fn host_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
284        self.inner = self.inner.host_key(input.into());
285        self
286    }
287    /// <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.</p>
288    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
289    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
290    /// <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p>
291    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
292    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
293    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
294    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
295    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
296    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
297    /// <p>If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p>
298    /// </important>
299    /// <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
300    pub fn set_host_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
301        self.inner = self.inner.set_host_key(input);
302        self
303    }
304    /// <p>The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.</p>
305    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
306    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
307    /// <p>Use a minimum value of 2048 for the <code>-b</code> option. You can create a stronger key by using 3072 or 4096.</p>
308    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
309    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
310    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
311    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
312    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
313    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
314    /// <p>If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p>
315    /// </important>
316    /// <p>For more information, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Manage host keys for your SFTP-enabled server</a> in the <i>Transfer Family User Guide</i>.</p>
317    pub fn get_host_key(&self) -> &::std::option::Option<::std::string::String> {
318        self.inner.get_host_key()
319    }
320    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
321    pub fn identity_provider_details(mut self, input: crate::types::IdentityProviderDetails) -> Self {
322        self.inner = self.inner.identity_provider_details(input);
323        self
324    }
325    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
326    pub fn set_identity_provider_details(mut self, input: ::std::option::Option<crate::types::IdentityProviderDetails>) -> Self {
327        self.inner = self.inner.set_identity_provider_details(input);
328        self
329    }
330    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
331    pub fn get_identity_provider_details(&self) -> &::std::option::Option<crate::types::IdentityProviderDetails> {
332        self.inner.get_identity_provider_details()
333    }
334    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>
335    pub fn logging_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
336        self.inner = self.inner.logging_role(input.into());
337        self
338    }
339    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>
340    pub fn set_logging_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
341        self.inner = self.inner.set_logging_role(input);
342        self
343    }
344    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.</p>
345    pub fn get_logging_role(&self) -> &::std::option::Option<::std::string::String> {
346        self.inner.get_logging_role()
347    }
348    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
349    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
350    /// </note>
351    pub fn post_authentication_login_banner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
352        self.inner = self.inner.post_authentication_login_banner(input.into());
353        self
354    }
355    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
356    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
357    /// </note>
358    pub fn set_post_authentication_login_banner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
359        self.inner = self.inner.set_post_authentication_login_banner(input);
360        self
361    }
362    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
363    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
364    /// </note>
365    pub fn get_post_authentication_login_banner(&self) -> &::std::option::Option<::std::string::String> {
366        self.inner.get_post_authentication_login_banner()
367    }
368    /// <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:</p>
369    /// <p><code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code></p>
370    pub fn pre_authentication_login_banner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
371        self.inner = self.inner.pre_authentication_login_banner(input.into());
372        self
373    }
374    /// <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:</p>
375    /// <p><code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code></p>
376    pub fn set_pre_authentication_login_banner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
377        self.inner = self.inner.set_pre_authentication_login_banner(input);
378        self
379    }
380    /// <p>Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:</p>
381    /// <p><code>This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.</code></p>
382    pub fn get_pre_authentication_login_banner(&self) -> &::std::option::Option<::std::string::String> {
383        self.inner.get_pre_authentication_login_banner()
384    }
385    ///
386    /// Appends an item to `Protocols`.
387    ///
388    /// To override the contents of this collection use [`set_protocols`](Self::set_protocols).
389    ///
390    /// <p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p>
391    /// <ul>
392    /// <li>
393    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
394    /// <li>
395    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
396    /// <li>
397    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
398    /// <li>
399    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
400    /// </ul><note>
401    /// <ul>
402    /// <li>
403    /// <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p></li>
404    /// <li>
405    /// <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be either <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p></li>
406    /// <li>
407    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
408    /// <li>
409    /// <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set any of the supported identity types: <code>SERVICE_MANAGED</code>, <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p></li>
410    /// <li>
411    /// <p>If <code>Protocol</code> includes <code>AS2</code>, then the <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p></li>
412    /// </ul>
413    /// </note>
414    pub fn protocols(mut self, input: crate::types::Protocol) -> Self {
415        self.inner = self.inner.protocols(input);
416        self
417    }
418    /// <p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p>
419    /// <ul>
420    /// <li>
421    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
422    /// <li>
423    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
424    /// <li>
425    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
426    /// <li>
427    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
428    /// </ul><note>
429    /// <ul>
430    /// <li>
431    /// <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p></li>
432    /// <li>
433    /// <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be either <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p></li>
434    /// <li>
435    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
436    /// <li>
437    /// <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set any of the supported identity types: <code>SERVICE_MANAGED</code>, <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p></li>
438    /// <li>
439    /// <p>If <code>Protocol</code> includes <code>AS2</code>, then the <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p></li>
440    /// </ul>
441    /// </note>
442    pub fn set_protocols(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Protocol>>) -> Self {
443        self.inner = self.inner.set_protocols(input);
444        self
445    }
446    /// <p>Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:</p>
447    /// <ul>
448    /// <li>
449    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
450    /// <li>
451    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
452    /// <li>
453    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
454    /// <li>
455    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
456    /// </ul><note>
457    /// <ul>
458    /// <li>
459    /// <p>If you select <code>FTPS</code>, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.</p></li>
460    /// <li>
461    /// <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the <code>EndpointType</code> must be <code>VPC</code> and the <code>IdentityProviderType</code> must be either <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p></li>
462    /// <li>
463    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
464    /// <li>
465    /// <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set any of the supported identity types: <code>SERVICE_MANAGED</code>, <code>AWS_DIRECTORY_SERVICE</code>, <code>AWS_LAMBDA</code>, or <code>API_GATEWAY</code>.</p></li>
466    /// <li>
467    /// <p>If <code>Protocol</code> includes <code>AS2</code>, then the <code>EndpointType</code> must be <code>VPC</code>, and domain must be Amazon S3.</p></li>
468    /// </ul>
469    /// </note>
470    pub fn get_protocols(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Protocol>> {
471        self.inner.get_protocols()
472    }
473    /// <p>Specifies the name of the security policy for the server.</p>
474    pub fn security_policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
475        self.inner = self.inner.security_policy_name(input.into());
476        self
477    }
478    /// <p>Specifies the name of the security policy for the server.</p>
479    pub fn set_security_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
480        self.inner = self.inner.set_security_policy_name(input);
481        self
482    }
483    /// <p>Specifies the name of the security policy for the server.</p>
484    pub fn get_security_policy_name(&self) -> &::std::option::Option<::std::string::String> {
485        self.inner.get_security_policy_name()
486    }
487    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
488    pub fn server_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
489        self.inner = self.inner.server_id(input.into());
490        self
491    }
492    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
493    pub fn set_server_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
494        self.inner = self.inner.set_server_id(input);
495        self
496    }
497    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
498    pub fn get_server_id(&self) -> &::std::option::Option<::std::string::String> {
499        self.inner.get_server_id()
500    }
501    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
502    /// <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.</p>
503    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
504    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
505    pub fn workflow_details(mut self, input: crate::types::WorkflowDetails) -> Self {
506        self.inner = self.inner.workflow_details(input);
507        self
508    }
509    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
510    /// <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.</p>
511    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
512    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
513    pub fn set_workflow_details(mut self, input: ::std::option::Option<crate::types::WorkflowDetails>) -> Self {
514        self.inner = self.inner.set_workflow_details(input);
515        self
516    }
517    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
518    /// <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.</p>
519    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
520    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
521    pub fn get_workflow_details(&self) -> &::std::option::Option<crate::types::WorkflowDetails> {
522        self.inner.get_workflow_details()
523    }
524    ///
525    /// Appends an item to `StructuredLogDestinations`.
526    ///
527    /// To override the contents of this collection use [`set_structured_log_destinations`](Self::set_structured_log_destinations).
528    ///
529    /// <p>Specifies the log groups to which your server logs are sent.</p>
530    /// <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
531    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
532    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
533    /// <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an <code>update-server</code> call. For example:</p>
534    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
535    pub fn structured_log_destinations(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
536        self.inner = self.inner.structured_log_destinations(input.into());
537        self
538    }
539    /// <p>Specifies the log groups to which your server logs are sent.</p>
540    /// <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
541    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
542    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
543    /// <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an <code>update-server</code> call. For example:</p>
544    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
545    pub fn set_structured_log_destinations(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
546        self.inner = self.inner.set_structured_log_destinations(input);
547        self
548    }
549    /// <p>Specifies the log groups to which your server logs are sent.</p>
550    /// <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
551    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
552    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
553    /// <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an <code>update-server</code> call. For example:</p>
554    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
555    pub fn get_structured_log_destinations(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
556        self.inner.get_structured_log_destinations()
557    }
558    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
559    /// <ul>
560    /// <li>
561    /// <p>If using the console, this is enabled by default.</p></li>
562    /// <li>
563    /// <p>If using the API or CLI, this is disabled by default.</p></li>
564    /// </ul>
565    /// <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
566    pub fn s3_storage_options(mut self, input: crate::types::S3StorageOptions) -> Self {
567        self.inner = self.inner.s3_storage_options(input);
568        self
569    }
570    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
571    /// <ul>
572    /// <li>
573    /// <p>If using the console, this is enabled by default.</p></li>
574    /// <li>
575    /// <p>If using the API or CLI, this is disabled by default.</p></li>
576    /// </ul>
577    /// <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
578    pub fn set_s3_storage_options(mut self, input: ::std::option::Option<crate::types::S3StorageOptions>) -> Self {
579        self.inner = self.inner.set_s3_storage_options(input);
580        self
581    }
582    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
583    /// <ul>
584    /// <li>
585    /// <p>If using the console, this is enabled by default.</p></li>
586    /// <li>
587    /// <p>If using the API or CLI, this is disabled by default.</p></li>
588    /// </ul>
589    /// <p>By default, home directory mappings have a <code>TYPE</code> of <code>DIRECTORY</code>. If you enable this option, you would then need to explicitly set the <code>HomeDirectoryMapEntry</code> <code>Type</code> to <code>FILE</code> if you want a mapping to have a file target.</p>
590    pub fn get_s3_storage_options(&self) -> &::std::option::Option<crate::types::S3StorageOptions> {
591        self.inner.get_s3_storage_options()
592    }
593    /// <p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p><important>
594    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
595    /// <ul>
596    /// <li>
597    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
598    /// <li>
599    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
600    /// </ul>
601    /// </important> <note>
602    /// <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p>
603    /// </note>
604    pub fn ip_address_type(mut self, input: crate::types::IpAddressType) -> Self {
605        self.inner = self.inner.ip_address_type(input);
606        self
607    }
608    /// <p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p><important>
609    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
610    /// <ul>
611    /// <li>
612    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
613    /// <li>
614    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
615    /// </ul>
616    /// </important> <note>
617    /// <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p>
618    /// </note>
619    pub fn set_ip_address_type(mut self, input: ::std::option::Option<crate::types::IpAddressType>) -> Self {
620        self.inner = self.inner.set_ip_address_type(input);
621        self
622    }
623    /// <p>Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is <code>IPV4</code>.</p><important>
624    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
625    /// <ul>
626    /// <li>
627    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
628    /// <li>
629    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
630    /// </ul>
631    /// </important> <note>
632    /// <p>When using <code>DUALSTACK</code> as the <code>IpAddressType</code>, you cannot set the <code>AddressAllocationIds</code> parameter for the <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html">EndpointDetails</a> for the server.</p>
633    /// </note>
634    pub fn get_ip_address_type(&self) -> &::std::option::Option<crate::types::IpAddressType> {
635        self.inner.get_ip_address_type()
636    }
637    /// <p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p>
638    /// <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p>
639    /// <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p>
640    /// <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>
641    pub fn identity_provider_type(mut self, input: crate::types::IdentityProviderType) -> Self {
642        self.inner = self.inner.identity_provider_type(input);
643        self
644    }
645    /// <p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p>
646    /// <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p>
647    /// <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p>
648    /// <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>
649    pub fn set_identity_provider_type(mut self, input: ::std::option::Option<crate::types::IdentityProviderType>) -> Self {
650        self.inner = self.inner.set_identity_provider_type(input);
651        self
652    }
653    /// <p>The mode of authentication for a server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within the Transfer Family service.</p>
654    /// <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the <code>IdentityProviderDetails</code> parameter.</p>
655    /// <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the <code>IdentityProviderDetails</code> parameter.</p>
656    /// <p>Use the <code>AWS_LAMBDA</code> value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>
657    pub fn get_identity_provider_type(&self) -> &::std::option::Option<crate::types::IdentityProviderType> {
658        self.inner.get_identity_provider_type()
659    }
660}