aws_sdk_transfer/operation/update_server/
_update_server_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
5pub struct UpdateServerInput {
6    /// <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>
7    /// <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>
8    /// <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>
9    /// <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>
10    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
11    /// <ul>
12    /// <li>
13    /// <p>2048-bit RSA (RSA_2048)</p></li>
14    /// <li>
15    /// <p>4096-bit RSA (RSA_4096)</p></li>
16    /// <li>
17    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
18    /// <li>
19    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
20    /// <li>
21    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
22    /// </ul><note>
23    /// <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>
24    /// </note>
25    pub certificate: ::std::option::Option<::std::string::String>,
26    /// <p>The protocol settings that are configured for your server.</p><note>
27    /// <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>
28    /// </note>
29    /// <ul>
30    /// <li>
31    /// <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>
32    /// <li>
33    /// <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>
34    /// <li>
35    /// <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>
36    /// <li>
37    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
38    /// </ul>
39    pub protocol_details: ::std::option::Option<crate::types::ProtocolDetails>,
40    /// <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>
41    pub endpoint_details: ::std::option::Option<crate::types::EndpointDetails>,
42    /// <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>
43    /// <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>
44    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
45    /// <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>
46    /// </note>
47    pub endpoint_type: ::std::option::Option<crate::types::EndpointType>,
48    /// <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>
49    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
50    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
51    /// <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>
52    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
53    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
54    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
55    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
56    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
57    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
58    /// <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>
59    /// </important>
60    /// <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>
61    pub host_key: ::std::option::Option<::std::string::String>,
62    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
63    pub identity_provider_details: ::std::option::Option<crate::types::IdentityProviderDetails>,
64    /// <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>
65    pub logging_role: ::std::option::Option<::std::string::String>,
66    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
67    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
68    /// </note>
69    pub post_authentication_login_banner: ::std::option::Option<::std::string::String>,
70    /// <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>
71    /// <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>
72    pub pre_authentication_login_banner: ::std::option::Option<::std::string::String>,
73    /// <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>
74    /// <ul>
75    /// <li>
76    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
77    /// <li>
78    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
79    /// <li>
80    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
81    /// <li>
82    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
83    /// </ul><note>
84    /// <ul>
85    /// <li>
86    /// <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>
87    /// <li>
88    /// <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>
89    /// <li>
90    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
91    /// <li>
92    /// <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>
93    /// <li>
94    /// <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>
95    /// </ul>
96    /// </note>
97    pub protocols: ::std::option::Option<::std::vec::Vec<crate::types::Protocol>>,
98    /// <p>Specifies the name of the security policy for the server.</p>
99    pub security_policy_name: ::std::option::Option<::std::string::String>,
100    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
101    pub server_id: ::std::option::Option<::std::string::String>,
102    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
103    /// <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>
104    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
105    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
106    pub workflow_details: ::std::option::Option<crate::types::WorkflowDetails>,
107    /// <p>Specifies the log groups to which your server logs are sent.</p>
108    /// <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>
109    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
110    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
111    /// <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>
112    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
113    pub structured_log_destinations: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
114    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
115    /// <ul>
116    /// <li>
117    /// <p>If using the console, this is enabled by default.</p></li>
118    /// <li>
119    /// <p>If using the API or CLI, this is disabled by default.</p></li>
120    /// </ul>
121    /// <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>
122    pub s3_storage_options: ::std::option::Option<crate::types::S3StorageOptions>,
123    /// <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>
124    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
125    /// <ul>
126    /// <li>
127    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
128    /// <li>
129    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
130    /// </ul>
131    /// </important> <note>
132    /// <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>
133    /// </note>
134    pub ip_address_type: ::std::option::Option<crate::types::IpAddressType>,
135    /// <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>
136    /// <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>
137    /// <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>
138    /// <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>
139    pub identity_provider_type: ::std::option::Option<crate::types::IdentityProviderType>,
140}
141impl UpdateServerInput {
142    /// <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>
143    /// <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>
144    /// <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>
145    /// <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>
146    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
147    /// <ul>
148    /// <li>
149    /// <p>2048-bit RSA (RSA_2048)</p></li>
150    /// <li>
151    /// <p>4096-bit RSA (RSA_4096)</p></li>
152    /// <li>
153    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
154    /// <li>
155    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
156    /// <li>
157    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
158    /// </ul><note>
159    /// <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>
160    /// </note>
161    pub fn certificate(&self) -> ::std::option::Option<&str> {
162        self.certificate.as_deref()
163    }
164    /// <p>The protocol settings that are configured for your server.</p><note>
165    /// <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>
166    /// </note>
167    /// <ul>
168    /// <li>
169    /// <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>
170    /// <li>
171    /// <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>
172    /// <li>
173    /// <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>
174    /// <li>
175    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
176    /// </ul>
177    pub fn protocol_details(&self) -> ::std::option::Option<&crate::types::ProtocolDetails> {
178        self.protocol_details.as_ref()
179    }
180    /// <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>
181    pub fn endpoint_details(&self) -> ::std::option::Option<&crate::types::EndpointDetails> {
182        self.endpoint_details.as_ref()
183    }
184    /// <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>
185    /// <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>
186    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
187    /// <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>
188    /// </note>
189    pub fn endpoint_type(&self) -> ::std::option::Option<&crate::types::EndpointType> {
190        self.endpoint_type.as_ref()
191    }
192    /// <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>
193    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
194    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
195    /// <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>
196    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
197    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
198    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
199    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
200    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
201    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
202    /// <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>
203    /// </important>
204    /// <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>
205    pub fn host_key(&self) -> ::std::option::Option<&str> {
206        self.host_key.as_deref()
207    }
208    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
209    pub fn identity_provider_details(&self) -> ::std::option::Option<&crate::types::IdentityProviderDetails> {
210        self.identity_provider_details.as_ref()
211    }
212    /// <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>
213    pub fn logging_role(&self) -> ::std::option::Option<&str> {
214        self.logging_role.as_deref()
215    }
216    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
217    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
218    /// </note>
219    pub fn post_authentication_login_banner(&self) -> ::std::option::Option<&str> {
220        self.post_authentication_login_banner.as_deref()
221    }
222    /// <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>
223    /// <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>
224    pub fn pre_authentication_login_banner(&self) -> ::std::option::Option<&str> {
225        self.pre_authentication_login_banner.as_deref()
226    }
227    /// <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>
228    /// <ul>
229    /// <li>
230    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
231    /// <li>
232    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
233    /// <li>
234    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
235    /// <li>
236    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
237    /// </ul><note>
238    /// <ul>
239    /// <li>
240    /// <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>
241    /// <li>
242    /// <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>
243    /// <li>
244    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
245    /// <li>
246    /// <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>
247    /// <li>
248    /// <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>
249    /// </ul>
250    /// </note>
251    ///
252    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.protocols.is_none()`.
253    pub fn protocols(&self) -> &[crate::types::Protocol] {
254        self.protocols.as_deref().unwrap_or_default()
255    }
256    /// <p>Specifies the name of the security policy for the server.</p>
257    pub fn security_policy_name(&self) -> ::std::option::Option<&str> {
258        self.security_policy_name.as_deref()
259    }
260    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
261    pub fn server_id(&self) -> ::std::option::Option<&str> {
262        self.server_id.as_deref()
263    }
264    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
265    /// <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>
266    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
267    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
268    pub fn workflow_details(&self) -> ::std::option::Option<&crate::types::WorkflowDetails> {
269        self.workflow_details.as_ref()
270    }
271    /// <p>Specifies the log groups to which your server logs are sent.</p>
272    /// <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>
273    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
274    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
275    /// <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>
276    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
277    ///
278    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.structured_log_destinations.is_none()`.
279    pub fn structured_log_destinations(&self) -> &[::std::string::String] {
280        self.structured_log_destinations.as_deref().unwrap_or_default()
281    }
282    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
283    /// <ul>
284    /// <li>
285    /// <p>If using the console, this is enabled by default.</p></li>
286    /// <li>
287    /// <p>If using the API or CLI, this is disabled by default.</p></li>
288    /// </ul>
289    /// <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>
290    pub fn s3_storage_options(&self) -> ::std::option::Option<&crate::types::S3StorageOptions> {
291        self.s3_storage_options.as_ref()
292    }
293    /// <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>
294    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
295    /// <ul>
296    /// <li>
297    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
298    /// <li>
299    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
300    /// </ul>
301    /// </important> <note>
302    /// <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>
303    /// </note>
304    pub fn ip_address_type(&self) -> ::std::option::Option<&crate::types::IpAddressType> {
305        self.ip_address_type.as_ref()
306    }
307    /// <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>
308    /// <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>
309    /// <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>
310    /// <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>
311    pub fn identity_provider_type(&self) -> ::std::option::Option<&crate::types::IdentityProviderType> {
312        self.identity_provider_type.as_ref()
313    }
314}
315impl ::std::fmt::Debug for UpdateServerInput {
316    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
317        let mut formatter = f.debug_struct("UpdateServerInput");
318        formatter.field("certificate", &self.certificate);
319        formatter.field("protocol_details", &self.protocol_details);
320        formatter.field("endpoint_details", &self.endpoint_details);
321        formatter.field("endpoint_type", &self.endpoint_type);
322        formatter.field("host_key", &"*** Sensitive Data Redacted ***");
323        formatter.field("identity_provider_details", &self.identity_provider_details);
324        formatter.field("logging_role", &self.logging_role);
325        formatter.field("post_authentication_login_banner", &self.post_authentication_login_banner);
326        formatter.field("pre_authentication_login_banner", &self.pre_authentication_login_banner);
327        formatter.field("protocols", &self.protocols);
328        formatter.field("security_policy_name", &self.security_policy_name);
329        formatter.field("server_id", &self.server_id);
330        formatter.field("workflow_details", &self.workflow_details);
331        formatter.field("structured_log_destinations", &self.structured_log_destinations);
332        formatter.field("s3_storage_options", &self.s3_storage_options);
333        formatter.field("ip_address_type", &self.ip_address_type);
334        formatter.field("identity_provider_type", &self.identity_provider_type);
335        formatter.finish()
336    }
337}
338impl UpdateServerInput {
339    /// Creates a new builder-style object to manufacture [`UpdateServerInput`](crate::operation::update_server::UpdateServerInput).
340    pub fn builder() -> crate::operation::update_server::builders::UpdateServerInputBuilder {
341        crate::operation::update_server::builders::UpdateServerInputBuilder::default()
342    }
343}
344
345/// A builder for [`UpdateServerInput`](crate::operation::update_server::UpdateServerInput).
346#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
347#[non_exhaustive]
348pub struct UpdateServerInputBuilder {
349    pub(crate) certificate: ::std::option::Option<::std::string::String>,
350    pub(crate) protocol_details: ::std::option::Option<crate::types::ProtocolDetails>,
351    pub(crate) endpoint_details: ::std::option::Option<crate::types::EndpointDetails>,
352    pub(crate) endpoint_type: ::std::option::Option<crate::types::EndpointType>,
353    pub(crate) host_key: ::std::option::Option<::std::string::String>,
354    pub(crate) identity_provider_details: ::std::option::Option<crate::types::IdentityProviderDetails>,
355    pub(crate) logging_role: ::std::option::Option<::std::string::String>,
356    pub(crate) post_authentication_login_banner: ::std::option::Option<::std::string::String>,
357    pub(crate) pre_authentication_login_banner: ::std::option::Option<::std::string::String>,
358    pub(crate) protocols: ::std::option::Option<::std::vec::Vec<crate::types::Protocol>>,
359    pub(crate) security_policy_name: ::std::option::Option<::std::string::String>,
360    pub(crate) server_id: ::std::option::Option<::std::string::String>,
361    pub(crate) workflow_details: ::std::option::Option<crate::types::WorkflowDetails>,
362    pub(crate) structured_log_destinations: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
363    pub(crate) s3_storage_options: ::std::option::Option<crate::types::S3StorageOptions>,
364    pub(crate) ip_address_type: ::std::option::Option<crate::types::IpAddressType>,
365    pub(crate) identity_provider_type: ::std::option::Option<crate::types::IdentityProviderType>,
366}
367impl UpdateServerInputBuilder {
368    /// <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>
369    /// <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>
370    /// <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>
371    /// <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>
372    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
373    /// <ul>
374    /// <li>
375    /// <p>2048-bit RSA (RSA_2048)</p></li>
376    /// <li>
377    /// <p>4096-bit RSA (RSA_4096)</p></li>
378    /// <li>
379    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
380    /// <li>
381    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
382    /// <li>
383    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
384    /// </ul><note>
385    /// <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>
386    /// </note>
387    pub fn certificate(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
388        self.certificate = ::std::option::Option::Some(input.into());
389        self
390    }
391    /// <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>
392    /// <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>
393    /// <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>
394    /// <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>
395    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
396    /// <ul>
397    /// <li>
398    /// <p>2048-bit RSA (RSA_2048)</p></li>
399    /// <li>
400    /// <p>4096-bit RSA (RSA_4096)</p></li>
401    /// <li>
402    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
403    /// <li>
404    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
405    /// <li>
406    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
407    /// </ul><note>
408    /// <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>
409    /// </note>
410    pub fn set_certificate(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
411        self.certificate = input;
412        self
413    }
414    /// <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>
415    /// <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>
416    /// <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>
417    /// <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>
418    /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
419    /// <ul>
420    /// <li>
421    /// <p>2048-bit RSA (RSA_2048)</p></li>
422    /// <li>
423    /// <p>4096-bit RSA (RSA_4096)</p></li>
424    /// <li>
425    /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
426    /// <li>
427    /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
428    /// <li>
429    /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
430    /// </ul><note>
431    /// <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>
432    /// </note>
433    pub fn get_certificate(&self) -> &::std::option::Option<::std::string::String> {
434        &self.certificate
435    }
436    /// <p>The protocol settings that are configured for your server.</p><note>
437    /// <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>
438    /// </note>
439    /// <ul>
440    /// <li>
441    /// <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>
442    /// <li>
443    /// <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>
444    /// <li>
445    /// <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>
446    /// <li>
447    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
448    /// </ul>
449    pub fn protocol_details(mut self, input: crate::types::ProtocolDetails) -> Self {
450        self.protocol_details = ::std::option::Option::Some(input);
451        self
452    }
453    /// <p>The protocol settings that are configured for your server.</p><note>
454    /// <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>
455    /// </note>
456    /// <ul>
457    /// <li>
458    /// <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>
459    /// <li>
460    /// <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>
461    /// <li>
462    /// <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>
463    /// <li>
464    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
465    /// </ul>
466    pub fn set_protocol_details(mut self, input: ::std::option::Option<crate::types::ProtocolDetails>) -> Self {
467        self.protocol_details = input;
468        self
469    }
470    /// <p>The protocol settings that are configured for your server.</p><note>
471    /// <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>
472    /// </note>
473    /// <ul>
474    /// <li>
475    /// <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>
476    /// <li>
477    /// <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>
478    /// <li>
479    /// <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>
480    /// <li>
481    /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
482    /// </ul>
483    pub fn get_protocol_details(&self) -> &::std::option::Option<crate::types::ProtocolDetails> {
484        &self.protocol_details
485    }
486    /// <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>
487    pub fn endpoint_details(mut self, input: crate::types::EndpointDetails) -> Self {
488        self.endpoint_details = ::std::option::Option::Some(input);
489        self
490    }
491    /// <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>
492    pub fn set_endpoint_details(mut self, input: ::std::option::Option<crate::types::EndpointDetails>) -> Self {
493        self.endpoint_details = input;
494        self
495    }
496    /// <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>
497    pub fn get_endpoint_details(&self) -> &::std::option::Option<crate::types::EndpointDetails> {
498        &self.endpoint_details
499    }
500    /// <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>
501    /// <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>
502    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
503    /// <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>
504    /// </note>
505    pub fn endpoint_type(mut self, input: crate::types::EndpointType) -> Self {
506        self.endpoint_type = ::std::option::Option::Some(input);
507        self
508    }
509    /// <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>
510    /// <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>
511    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
512    /// <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>
513    /// </note>
514    pub fn set_endpoint_type(mut self, input: ::std::option::Option<crate::types::EndpointType>) -> Self {
515        self.endpoint_type = input;
516        self
517    }
518    /// <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>
519    /// <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>
520    /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
521    /// <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>
522    /// </note>
523    pub fn get_endpoint_type(&self) -> &::std::option::Option<crate::types::EndpointType> {
524        &self.endpoint_type
525    }
526    /// <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>
527    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
528    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
529    /// <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>
530    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
531    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
532    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
533    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
534    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
535    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
536    /// <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>
537    /// </important>
538    /// <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>
539    pub fn host_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
540        self.host_key = ::std::option::Option::Some(input.into());
541        self
542    }
543    /// <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>
544    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
545    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
546    /// <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>
547    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
548    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
549    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
550    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
551    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
552    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
553    /// <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>
554    /// </important>
555    /// <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>
556    pub fn set_host_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
557        self.host_key = input;
558        self
559    }
560    /// <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>
561    /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
562    /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
563    /// <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>
564    /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
565    /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
566    /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
567    /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
568    /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
569    /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
570    /// <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>
571    /// </important>
572    /// <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>
573    pub fn get_host_key(&self) -> &::std::option::Option<::std::string::String> {
574        &self.host_key
575    }
576    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
577    pub fn identity_provider_details(mut self, input: crate::types::IdentityProviderDetails) -> Self {
578        self.identity_provider_details = ::std::option::Option::Some(input);
579        self
580    }
581    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
582    pub fn set_identity_provider_details(mut self, input: ::std::option::Option<crate::types::IdentityProviderDetails>) -> Self {
583        self.identity_provider_details = input;
584        self
585    }
586    /// <p>An array containing all of the information required to call a customer's authentication API method.</p>
587    pub fn get_identity_provider_details(&self) -> &::std::option::Option<crate::types::IdentityProviderDetails> {
588        &self.identity_provider_details
589    }
590    /// <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>
591    pub fn logging_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
592        self.logging_role = ::std::option::Option::Some(input.into());
593        self
594    }
595    /// <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>
596    pub fn set_logging_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
597        self.logging_role = input;
598        self
599    }
600    /// <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>
601    pub fn get_logging_role(&self) -> &::std::option::Option<::std::string::String> {
602        &self.logging_role
603    }
604    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
605    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
606    /// </note>
607    pub fn post_authentication_login_banner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
608        self.post_authentication_login_banner = ::std::option::Option::Some(input.into());
609        self
610    }
611    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
612    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
613    /// </note>
614    pub fn set_post_authentication_login_banner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
615        self.post_authentication_login_banner = input;
616        self
617    }
618    /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
619    /// <p>The SFTP protocol does not support post-authentication display banners.</p>
620    /// </note>
621    pub fn get_post_authentication_login_banner(&self) -> &::std::option::Option<::std::string::String> {
622        &self.post_authentication_login_banner
623    }
624    /// <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>
625    /// <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>
626    pub fn pre_authentication_login_banner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
627        self.pre_authentication_login_banner = ::std::option::Option::Some(input.into());
628        self
629    }
630    /// <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>
631    /// <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>
632    pub fn set_pre_authentication_login_banner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
633        self.pre_authentication_login_banner = input;
634        self
635    }
636    /// <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>
637    /// <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>
638    pub fn get_pre_authentication_login_banner(&self) -> &::std::option::Option<::std::string::String> {
639        &self.pre_authentication_login_banner
640    }
641    /// Appends an item to `protocols`.
642    ///
643    /// To override the contents of this collection use [`set_protocols`](Self::set_protocols).
644    ///
645    /// <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>
646    /// <ul>
647    /// <li>
648    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
649    /// <li>
650    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
651    /// <li>
652    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
653    /// <li>
654    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
655    /// </ul><note>
656    /// <ul>
657    /// <li>
658    /// <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>
659    /// <li>
660    /// <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>
661    /// <li>
662    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
663    /// <li>
664    /// <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>
665    /// <li>
666    /// <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>
667    /// </ul>
668    /// </note>
669    pub fn protocols(mut self, input: crate::types::Protocol) -> Self {
670        let mut v = self.protocols.unwrap_or_default();
671        v.push(input);
672        self.protocols = ::std::option::Option::Some(v);
673        self
674    }
675    /// <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>
676    /// <ul>
677    /// <li>
678    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
679    /// <li>
680    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
681    /// <li>
682    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
683    /// <li>
684    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
685    /// </ul><note>
686    /// <ul>
687    /// <li>
688    /// <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>
689    /// <li>
690    /// <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>
691    /// <li>
692    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
693    /// <li>
694    /// <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>
695    /// <li>
696    /// <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>
697    /// </ul>
698    /// </note>
699    pub fn set_protocols(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Protocol>>) -> Self {
700        self.protocols = input;
701        self
702    }
703    /// <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>
704    /// <ul>
705    /// <li>
706    /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
707    /// <li>
708    /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
709    /// <li>
710    /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
711    /// <li>
712    /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
713    /// </ul><note>
714    /// <ul>
715    /// <li>
716    /// <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>
717    /// <li>
718    /// <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>
719    /// <li>
720    /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
721    /// <li>
722    /// <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>
723    /// <li>
724    /// <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>
725    /// </ul>
726    /// </note>
727    pub fn get_protocols(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Protocol>> {
728        &self.protocols
729    }
730    /// <p>Specifies the name of the security policy for the server.</p>
731    pub fn security_policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
732        self.security_policy_name = ::std::option::Option::Some(input.into());
733        self
734    }
735    /// <p>Specifies the name of the security policy for the server.</p>
736    pub fn set_security_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
737        self.security_policy_name = input;
738        self
739    }
740    /// <p>Specifies the name of the security policy for the server.</p>
741    pub fn get_security_policy_name(&self) -> &::std::option::Option<::std::string::String> {
742        &self.security_policy_name
743    }
744    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
745    /// This field is required.
746    pub fn server_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
747        self.server_id = ::std::option::Option::Some(input.into());
748        self
749    }
750    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
751    pub fn set_server_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
752        self.server_id = input;
753        self
754    }
755    /// <p>A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.</p>
756    pub fn get_server_id(&self) -> &::std::option::Option<::std::string::String> {
757        &self.server_id
758    }
759    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
760    /// <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>
761    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
762    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
763    pub fn workflow_details(mut self, input: crate::types::WorkflowDetails) -> Self {
764        self.workflow_details = ::std::option::Option::Some(input);
765        self
766    }
767    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
768    /// <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>
769    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
770    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
771    pub fn set_workflow_details(mut self, input: ::std::option::Option<crate::types::WorkflowDetails>) -> Self {
772        self.workflow_details = input;
773        self
774    }
775    /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
776    /// <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>
777    /// <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>
778    /// <p><code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":\[\]}'</code></p>
779    pub fn get_workflow_details(&self) -> &::std::option::Option<crate::types::WorkflowDetails> {
780        &self.workflow_details
781    }
782    /// Appends an item to `structured_log_destinations`.
783    ///
784    /// To override the contents of this collection use [`set_structured_log_destinations`](Self::set_structured_log_destinations).
785    ///
786    /// <p>Specifies the log groups to which your server logs are sent.</p>
787    /// <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>
788    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
789    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
790    /// <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>
791    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
792    pub fn structured_log_destinations(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
793        let mut v = self.structured_log_destinations.unwrap_or_default();
794        v.push(input.into());
795        self.structured_log_destinations = ::std::option::Option::Some(v);
796        self
797    }
798    /// <p>Specifies the log groups to which your server logs are sent.</p>
799    /// <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>
800    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
801    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
802    /// <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>
803    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
804    pub fn set_structured_log_destinations(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
805        self.structured_log_destinations = input;
806        self
807    }
808    /// <p>Specifies the log groups to which your server logs are sent.</p>
809    /// <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>
810    /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
811    /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
812    /// <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>
813    /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
814    pub fn get_structured_log_destinations(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
815        &self.structured_log_destinations
816    }
817    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
818    /// <ul>
819    /// <li>
820    /// <p>If using the console, this is enabled by default.</p></li>
821    /// <li>
822    /// <p>If using the API or CLI, this is disabled by default.</p></li>
823    /// </ul>
824    /// <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>
825    pub fn s3_storage_options(mut self, input: crate::types::S3StorageOptions) -> Self {
826        self.s3_storage_options = ::std::option::Option::Some(input);
827        self
828    }
829    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
830    /// <ul>
831    /// <li>
832    /// <p>If using the console, this is enabled by default.</p></li>
833    /// <li>
834    /// <p>If using the API or CLI, this is disabled by default.</p></li>
835    /// </ul>
836    /// <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>
837    pub fn set_s3_storage_options(mut self, input: ::std::option::Option<crate::types::S3StorageOptions>) -> Self {
838        self.s3_storage_options = input;
839        self
840    }
841    /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
842    /// <ul>
843    /// <li>
844    /// <p>If using the console, this is enabled by default.</p></li>
845    /// <li>
846    /// <p>If using the API or CLI, this is disabled by default.</p></li>
847    /// </ul>
848    /// <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>
849    pub fn get_s3_storage_options(&self) -> &::std::option::Option<crate::types::S3StorageOptions> {
850        &self.s3_storage_options
851    }
852    /// <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>
853    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
854    /// <ul>
855    /// <li>
856    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
857    /// <li>
858    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
859    /// </ul>
860    /// </important> <note>
861    /// <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>
862    /// </note>
863    pub fn ip_address_type(mut self, input: crate::types::IpAddressType) -> Self {
864        self.ip_address_type = ::std::option::Option::Some(input);
865        self
866    }
867    /// <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>
868    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
869    /// <ul>
870    /// <li>
871    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
872    /// <li>
873    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
874    /// </ul>
875    /// </important> <note>
876    /// <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>
877    /// </note>
878    pub fn set_ip_address_type(mut self, input: ::std::option::Option<crate::types::IpAddressType>) -> Self {
879        self.ip_address_type = input;
880        self
881    }
882    /// <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>
883    /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
884    /// <ul>
885    /// <li>
886    /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
887    /// <li>
888    /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
889    /// </ul>
890    /// </important> <note>
891    /// <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>
892    /// </note>
893    pub fn get_ip_address_type(&self) -> &::std::option::Option<crate::types::IpAddressType> {
894        &self.ip_address_type
895    }
896    /// <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>
897    /// <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>
898    /// <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>
899    /// <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>
900    pub fn identity_provider_type(mut self, input: crate::types::IdentityProviderType) -> Self {
901        self.identity_provider_type = ::std::option::Option::Some(input);
902        self
903    }
904    /// <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>
905    /// <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>
906    /// <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>
907    /// <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>
908    pub fn set_identity_provider_type(mut self, input: ::std::option::Option<crate::types::IdentityProviderType>) -> Self {
909        self.identity_provider_type = input;
910        self
911    }
912    /// <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>
913    /// <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>
914    /// <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>
915    /// <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>
916    pub fn get_identity_provider_type(&self) -> &::std::option::Option<crate::types::IdentityProviderType> {
917        &self.identity_provider_type
918    }
919    /// Consumes the builder and constructs a [`UpdateServerInput`](crate::operation::update_server::UpdateServerInput).
920    pub fn build(
921        self,
922    ) -> ::std::result::Result<crate::operation::update_server::UpdateServerInput, ::aws_smithy_types::error::operation::BuildError> {
923        ::std::result::Result::Ok(crate::operation::update_server::UpdateServerInput {
924            certificate: self.certificate,
925            protocol_details: self.protocol_details,
926            endpoint_details: self.endpoint_details,
927            endpoint_type: self.endpoint_type,
928            host_key: self.host_key,
929            identity_provider_details: self.identity_provider_details,
930            logging_role: self.logging_role,
931            post_authentication_login_banner: self.post_authentication_login_banner,
932            pre_authentication_login_banner: self.pre_authentication_login_banner,
933            protocols: self.protocols,
934            security_policy_name: self.security_policy_name,
935            server_id: self.server_id,
936            workflow_details: self.workflow_details,
937            structured_log_destinations: self.structured_log_destinations,
938            s3_storage_options: self.s3_storage_options,
939            ip_address_type: self.ip_address_type,
940            identity_provider_type: self.identity_provider_type,
941        })
942    }
943}
944impl ::std::fmt::Debug for UpdateServerInputBuilder {
945    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
946        let mut formatter = f.debug_struct("UpdateServerInputBuilder");
947        formatter.field("certificate", &self.certificate);
948        formatter.field("protocol_details", &self.protocol_details);
949        formatter.field("endpoint_details", &self.endpoint_details);
950        formatter.field("endpoint_type", &self.endpoint_type);
951        formatter.field("host_key", &"*** Sensitive Data Redacted ***");
952        formatter.field("identity_provider_details", &self.identity_provider_details);
953        formatter.field("logging_role", &self.logging_role);
954        formatter.field("post_authentication_login_banner", &self.post_authentication_login_banner);
955        formatter.field("pre_authentication_login_banner", &self.pre_authentication_login_banner);
956        formatter.field("protocols", &self.protocols);
957        formatter.field("security_policy_name", &self.security_policy_name);
958        formatter.field("server_id", &self.server_id);
959        formatter.field("workflow_details", &self.workflow_details);
960        formatter.field("structured_log_destinations", &self.structured_log_destinations);
961        formatter.field("s3_storage_options", &self.s3_storage_options);
962        formatter.field("ip_address_type", &self.ip_address_type);
963        formatter.field("identity_provider_type", &self.identity_provider_type);
964        formatter.finish()
965    }
966}