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