aws_sdk_transfer/operation/create_server/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_server::_create_server_output::CreateServerOutputBuilder;
3
4pub use crate::operation::create_server::_create_server_input::CreateServerInputBuilder;
5
6impl crate::operation::create_server::builders::CreateServerInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::create_server::CreateServerOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_server::CreateServerError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_server();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateServer`.
24///
25/// <p>Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateServerFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::create_server::builders::CreateServerInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::create_server::CreateServerOutput,
35 crate::operation::create_server::CreateServerError,
36 > for CreateServerFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::create_server::CreateServerOutput,
44 crate::operation::create_server::CreateServerError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl CreateServerFluentBuilder {
51 /// Creates a new `CreateServerFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the CreateServer as a reference.
60 pub fn as_input(&self) -> &crate::operation::create_server::builders::CreateServerInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::create_server::CreateServerOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::create_server::CreateServerError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::create_server::CreateServer::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::create_server::CreateServer::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::create_server::CreateServerOutput,
97 crate::operation::create_server::CreateServerError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
112 /// <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>Certificate Manager User Guide</i>.</p>
113 /// <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>Certificate Manager User Guide</i>.</p>
114 /// <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>Certificate Manager User Guide</i>.</p>
115 /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
116 /// <ul>
117 /// <li>
118 /// <p>2048-bit RSA (RSA_2048)</p></li>
119 /// <li>
120 /// <p>4096-bit RSA (RSA_4096)</p></li>
121 /// <li>
122 /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
123 /// <li>
124 /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
125 /// <li>
126 /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
127 /// </ul><note>
128 /// <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>
129 /// </note>
130 pub fn certificate(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131 self.inner = self.inner.certificate(input.into());
132 self
133 }
134 /// <p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
135 /// <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>Certificate Manager User Guide</i>.</p>
136 /// <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>Certificate Manager User Guide</i>.</p>
137 /// <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>Certificate Manager User Guide</i>.</p>
138 /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
139 /// <ul>
140 /// <li>
141 /// <p>2048-bit RSA (RSA_2048)</p></li>
142 /// <li>
143 /// <p>4096-bit RSA (RSA_4096)</p></li>
144 /// <li>
145 /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
146 /// <li>
147 /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
148 /// <li>
149 /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
150 /// </ul><note>
151 /// <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>
152 /// </note>
153 pub fn set_certificate(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
154 self.inner = self.inner.set_certificate(input);
155 self
156 }
157 /// <p>The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when <code>Protocols</code> is set to <code>FTPS</code>.</p>
158 /// <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>Certificate Manager User Guide</i>.</p>
159 /// <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>Certificate Manager User Guide</i>.</p>
160 /// <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>Certificate Manager User Guide</i>.</p>
161 /// <p>Certificates with the following cryptographic algorithms and key sizes are supported:</p>
162 /// <ul>
163 /// <li>
164 /// <p>2048-bit RSA (RSA_2048)</p></li>
165 /// <li>
166 /// <p>4096-bit RSA (RSA_4096)</p></li>
167 /// <li>
168 /// <p>Elliptic Prime Curve 256 bit (EC_prime256v1)</p></li>
169 /// <li>
170 /// <p>Elliptic Prime Curve 384 bit (EC_secp384r1)</p></li>
171 /// <li>
172 /// <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p></li>
173 /// </ul><note>
174 /// <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>
175 /// </note>
176 pub fn get_certificate(&self) -> &::std::option::Option<::std::string::String> {
177 self.inner.get_certificate()
178 }
179 /// <p>The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.</p><note>
180 /// <p>After the server is created, the domain cannot be changed.</p>
181 /// </note>
182 pub fn domain(mut self, input: crate::types::Domain) -> Self {
183 self.inner = self.inner.domain(input);
184 self
185 }
186 /// <p>The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.</p><note>
187 /// <p>After the server is created, the domain cannot be changed.</p>
188 /// </note>
189 pub fn set_domain(mut self, input: ::std::option::Option<crate::types::Domain>) -> Self {
190 self.inner = self.inner.set_domain(input);
191 self
192 }
193 /// <p>The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.</p><note>
194 /// <p>After the server is created, the domain cannot be changed.</p>
195 /// </note>
196 pub fn get_domain(&self) -> &::std::option::Option<crate::types::Domain> {
197 self.inner.get_domain()
198 }
199 /// <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>
200 pub fn endpoint_details(mut self, input: crate::types::EndpointDetails) -> Self {
201 self.inner = self.inner.endpoint_details(input);
202 self
203 }
204 /// <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>
205 pub fn set_endpoint_details(mut self, input: ::std::option::Option<crate::types::EndpointDetails>) -> Self {
206 self.inner = self.inner.set_endpoint_details(input);
207 self
208 }
209 /// <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>
210 pub fn get_endpoint_details(&self) -> &::std::option::Option<crate::types::EndpointDetails> {
211 self.inner.get_endpoint_details()
212 }
213 /// <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>
214 /// <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>
215 /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
216 /// <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>
217 /// </note>
218 pub fn endpoint_type(mut self, input: crate::types::EndpointType) -> Self {
219 self.inner = self.inner.endpoint_type(input);
220 self
221 }
222 /// <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>
223 /// <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>
224 /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
225 /// <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>
226 /// </note>
227 pub fn set_endpoint_type(mut self, input: ::std::option::Option<crate::types::EndpointType>) -> Self {
228 self.inner = self.inner.set_endpoint_type(input);
229 self
230 }
231 /// <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>
232 /// <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>
233 /// <p>For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.</p>
234 /// <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>
235 /// </note>
236 pub fn get_endpoint_type(&self) -> &::std::option::Option<crate::types::EndpointType> {
237 self.inner.get_endpoint_type()
238 }
239 /// <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>
240 /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
241 /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
242 /// <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>
243 /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
244 /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
245 /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
246 /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
247 /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
248 /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
249 /// <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>
250 /// </important>
251 /// <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>
252 pub fn host_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
253 self.inner = self.inner.host_key(input.into());
254 self
255 }
256 /// <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>
257 /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
258 /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
259 /// <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>
260 /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
261 /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
262 /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
263 /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
264 /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
265 /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
266 /// <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>
267 /// </important>
268 /// <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>
269 pub fn set_host_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
270 self.inner = self.inner.set_host_key(input);
271 self
272 }
273 /// <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>
274 /// <p>Use the following command to generate an RSA 2048 bit key with no passphrase:</p>
275 /// <p><code>ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key</code>.</p>
276 /// <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>
277 /// <p>Use the following command to generate an ECDSA 256 bit key with no passphrase:</p>
278 /// <p><code>ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key</code>.</p>
279 /// <p>Valid values for the <code>-b</code> option for ECDSA are 256, 384, and 521.</p>
280 /// <p>Use the following command to generate an ED25519 key with no passphrase:</p>
281 /// <p><code>ssh-keygen -t ed25519 -N "" -f my-new-server-key</code>.</p>
282 /// <p>For all of these commands, you can replace <i>my-new-server-key</i> with a string of your choice.</p><important>
283 /// <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>
284 /// </important>
285 /// <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>
286 pub fn get_host_key(&self) -> &::std::option::Option<::std::string::String> {
287 self.inner.get_host_key()
288 }
289 /// <p>Required when <code>IdentityProviderType</code> is set to <code>AWS_DIRECTORY_SERVICE</code>, <code>Amazon Web Services_LAMBDA</code> or <code>API_GATEWAY</code>. Accepts an array containing all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
290 pub fn identity_provider_details(mut self, input: crate::types::IdentityProviderDetails) -> Self {
291 self.inner = self.inner.identity_provider_details(input);
292 self
293 }
294 /// <p>Required when <code>IdentityProviderType</code> is set to <code>AWS_DIRECTORY_SERVICE</code>, <code>Amazon Web Services_LAMBDA</code> or <code>API_GATEWAY</code>. Accepts an array containing all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
295 pub fn set_identity_provider_details(mut self, input: ::std::option::Option<crate::types::IdentityProviderDetails>) -> Self {
296 self.inner = self.inner.set_identity_provider_details(input);
297 self
298 }
299 /// <p>Required when <code>IdentityProviderType</code> is set to <code>AWS_DIRECTORY_SERVICE</code>, <code>Amazon Web Services_LAMBDA</code> or <code>API_GATEWAY</code>. Accepts an array containing all of the information required to use a directory in <code>AWS_DIRECTORY_SERVICE</code> or invoke a customer-supplied authentication API, including the API Gateway URL. Cannot be specified when <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>
300 pub fn get_identity_provider_details(&self) -> &::std::option::Option<crate::types::IdentityProviderDetails> {
301 self.inner.get_identity_provider_details()
302 }
303 /// <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>
304 /// <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>
305 /// <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>
306 /// <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>
307 pub fn identity_provider_type(mut self, input: crate::types::IdentityProviderType) -> Self {
308 self.inner = self.inner.identity_provider_type(input);
309 self
310 }
311 /// <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>
312 /// <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>
313 /// <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>
314 /// <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>
315 pub fn set_identity_provider_type(mut self, input: ::std::option::Option<crate::types::IdentityProviderType>) -> Self {
316 self.inner = self.inner.set_identity_provider_type(input);
317 self
318 }
319 /// <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>
320 /// <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>
321 /// <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>
322 /// <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>
323 pub fn get_identity_provider_type(&self) -> &::std::option::Option<crate::types::IdentityProviderType> {
324 self.inner.get_identity_provider_type()
325 }
326 /// <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>
327 pub fn logging_role(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
328 self.inner = self.inner.logging_role(input.into());
329 self
330 }
331 /// <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>
332 pub fn set_logging_role(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
333 self.inner = self.inner.set_logging_role(input);
334 self
335 }
336 /// <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>
337 pub fn get_logging_role(&self) -> &::std::option::Option<::std::string::String> {
338 self.inner.get_logging_role()
339 }
340 /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
341 /// <p>The SFTP protocol does not support post-authentication display banners.</p>
342 /// </note>
343 pub fn post_authentication_login_banner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
344 self.inner = self.inner.post_authentication_login_banner(input.into());
345 self
346 }
347 /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
348 /// <p>The SFTP protocol does not support post-authentication display banners.</p>
349 /// </note>
350 pub fn set_post_authentication_login_banner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
351 self.inner = self.inner.set_post_authentication_login_banner(input);
352 self
353 }
354 /// <p>Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.</p><note>
355 /// <p>The SFTP protocol does not support post-authentication display banners.</p>
356 /// </note>
357 pub fn get_post_authentication_login_banner(&self) -> &::std::option::Option<::std::string::String> {
358 self.inner.get_post_authentication_login_banner()
359 }
360 /// <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>
361 /// <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>
362 pub fn pre_authentication_login_banner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
363 self.inner = self.inner.pre_authentication_login_banner(input.into());
364 self
365 }
366 /// <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>
367 /// <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>
368 pub fn set_pre_authentication_login_banner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
369 self.inner = self.inner.set_pre_authentication_login_banner(input);
370 self
371 }
372 /// <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>
373 /// <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>
374 pub fn get_pre_authentication_login_banner(&self) -> &::std::option::Option<::std::string::String> {
375 self.inner.get_pre_authentication_login_banner()
376 }
377 ///
378 /// Appends an item to `Protocols`.
379 ///
380 /// To override the contents of this collection use [`set_protocols`](Self::set_protocols).
381 ///
382 /// <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>
383 /// <ul>
384 /// <li>
385 /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
386 /// <li>
387 /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
388 /// <li>
389 /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
390 /// <li>
391 /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
392 /// </ul><note>
393 /// <ul>
394 /// <li>
395 /// <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>
396 /// <li>
397 /// <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>
398 /// <li>
399 /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
400 /// <li>
401 /// <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>
402 /// <li>
403 /// <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>
404 /// </ul>
405 /// </note>
406 pub fn protocols(mut self, input: crate::types::Protocol) -> Self {
407 self.inner = self.inner.protocols(input);
408 self
409 }
410 /// <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>
411 /// <ul>
412 /// <li>
413 /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
414 /// <li>
415 /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
416 /// <li>
417 /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
418 /// <li>
419 /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
420 /// </ul><note>
421 /// <ul>
422 /// <li>
423 /// <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>
424 /// <li>
425 /// <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>
426 /// <li>
427 /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
428 /// <li>
429 /// <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>
430 /// <li>
431 /// <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>
432 /// </ul>
433 /// </note>
434 pub fn set_protocols(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Protocol>>) -> Self {
435 self.inner = self.inner.set_protocols(input);
436 self
437 }
438 /// <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>
439 /// <ul>
440 /// <li>
441 /// <p><code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH</p></li>
442 /// <li>
443 /// <p><code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS encryption</p></li>
444 /// <li>
445 /// <p><code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p></li>
446 /// <li>
447 /// <p><code>AS2</code> (Applicability Statement 2): used for transporting structured business-to-business data</p></li>
448 /// </ul><note>
449 /// <ul>
450 /// <li>
451 /// <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>
452 /// <li>
453 /// <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>
454 /// <li>
455 /// <p>If <code>Protocol</code> includes <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be associated.</p></li>
456 /// <li>
457 /// <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>
458 /// <li>
459 /// <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>
460 /// </ul>
461 /// </note>
462 pub fn get_protocols(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Protocol>> {
463 self.inner.get_protocols()
464 }
465 /// <p>The protocol settings that are configured for your server.</p><note>
466 /// <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>
467 /// </note>
468 /// <ul>
469 /// <li>
470 /// <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>
471 /// <li>
472 /// <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>
473 /// <li>
474 /// <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>
475 /// <li>
476 /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
477 /// </ul>
478 pub fn protocol_details(mut self, input: crate::types::ProtocolDetails) -> Self {
479 self.inner = self.inner.protocol_details(input);
480 self
481 }
482 /// <p>The protocol settings that are configured for your server.</p><note>
483 /// <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>
484 /// </note>
485 /// <ul>
486 /// <li>
487 /// <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>
488 /// <li>
489 /// <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>
490 /// <li>
491 /// <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>
492 /// <li>
493 /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
494 /// </ul>
495 pub fn set_protocol_details(mut self, input: ::std::option::Option<crate::types::ProtocolDetails>) -> Self {
496 self.inner = self.inner.set_protocol_details(input);
497 self
498 }
499 /// <p>The protocol settings that are configured for your server.</p><note>
500 /// <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>
501 /// </note>
502 /// <ul>
503 /// <li>
504 /// <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>
505 /// <li>
506 /// <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>
507 /// <li>
508 /// <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>
509 /// <li>
510 /// <p><code>As2Transports</code> indicates the transport method for the AS2 messages. Currently, only HTTP is supported.</p></li>
511 /// </ul>
512 pub fn get_protocol_details(&self) -> &::std::option::Option<crate::types::ProtocolDetails> {
513 self.inner.get_protocol_details()
514 }
515 /// <p>Specifies the name of the security policy for the server.</p>
516 pub fn security_policy_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
517 self.inner = self.inner.security_policy_name(input.into());
518 self
519 }
520 /// <p>Specifies the name of the security policy for the server.</p>
521 pub fn set_security_policy_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
522 self.inner = self.inner.set_security_policy_name(input);
523 self
524 }
525 /// <p>Specifies the name of the security policy for the server.</p>
526 pub fn get_security_policy_name(&self) -> &::std::option::Option<::std::string::String> {
527 self.inner.get_security_policy_name()
528 }
529 ///
530 /// Appends an item to `Tags`.
531 ///
532 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
533 ///
534 /// <p>Key-value pairs that can be used to group and search for servers.</p>
535 pub fn tags(mut self, input: crate::types::Tag) -> Self {
536 self.inner = self.inner.tags(input);
537 self
538 }
539 /// <p>Key-value pairs that can be used to group and search for servers.</p>
540 pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
541 self.inner = self.inner.set_tags(input);
542 self
543 }
544 /// <p>Key-value pairs that can be used to group and search for servers.</p>
545 pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
546 self.inner.get_tags()
547 }
548 /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
549 /// <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>
550 pub fn workflow_details(mut self, input: crate::types::WorkflowDetails) -> Self {
551 self.inner = self.inner.workflow_details(input);
552 self
553 }
554 /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
555 /// <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>
556 pub fn set_workflow_details(mut self, input: ::std::option::Option<crate::types::WorkflowDetails>) -> Self {
557 self.inner = self.inner.set_workflow_details(input);
558 self
559 }
560 /// <p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>
561 /// <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>
562 pub fn get_workflow_details(&self) -> &::std::option::Option<crate::types::WorkflowDetails> {
563 self.inner.get_workflow_details()
564 }
565 ///
566 /// Appends an item to `StructuredLogDestinations`.
567 ///
568 /// To override the contents of this collection use [`set_structured_log_destinations`](Self::set_structured_log_destinations).
569 ///
570 /// <p>Specifies the log groups to which your server logs are sent.</p>
571 /// <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>
572 /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
573 /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
574 /// <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>
575 /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
576 pub fn structured_log_destinations(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
577 self.inner = self.inner.structured_log_destinations(input.into());
578 self
579 }
580 /// <p>Specifies the log groups to which your server logs are sent.</p>
581 /// <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>
582 /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
583 /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
584 /// <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>
585 /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
586 pub fn set_structured_log_destinations(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
587 self.inner = self.inner.set_structured_log_destinations(input);
588 self
589 }
590 /// <p>Specifies the log groups to which your server logs are sent.</p>
591 /// <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>
592 /// <p><code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code></p>
593 /// <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code></p>
594 /// <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>
595 /// <p><code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code></p>
596 pub fn get_structured_log_destinations(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
597 self.inner.get_structured_log_destinations()
598 }
599 /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
600 /// <ul>
601 /// <li>
602 /// <p>If using the console, this is enabled by default.</p></li>
603 /// <li>
604 /// <p>If using the API or CLI, this is disabled by default.</p></li>
605 /// </ul>
606 /// <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>
607 pub fn s3_storage_options(mut self, input: crate::types::S3StorageOptions) -> Self {
608 self.inner = self.inner.s3_storage_options(input);
609 self
610 }
611 /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
612 /// <ul>
613 /// <li>
614 /// <p>If using the console, this is enabled by default.</p></li>
615 /// <li>
616 /// <p>If using the API or CLI, this is disabled by default.</p></li>
617 /// </ul>
618 /// <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>
619 pub fn set_s3_storage_options(mut self, input: ::std::option::Option<crate::types::S3StorageOptions>) -> Self {
620 self.inner = self.inner.set_s3_storage_options(input);
621 self
622 }
623 /// <p>Specifies whether or not performance for your Amazon S3 directories is optimized.</p>
624 /// <ul>
625 /// <li>
626 /// <p>If using the console, this is enabled by default.</p></li>
627 /// <li>
628 /// <p>If using the API or CLI, this is disabled by default.</p></li>
629 /// </ul>
630 /// <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>
631 pub fn get_s3_storage_options(&self) -> &::std::option::Option<crate::types::S3StorageOptions> {
632 self.inner.get_s3_storage_options()
633 }
634 /// <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>
635 /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
636 /// <ul>
637 /// <li>
638 /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
639 /// <li>
640 /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
641 /// </ul>
642 /// </important> <note>
643 /// <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>
644 /// </note>
645 pub fn ip_address_type(mut self, input: crate::types::IpAddressType) -> Self {
646 self.inner = self.inner.ip_address_type(input);
647 self
648 }
649 /// <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>
650 /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
651 /// <ul>
652 /// <li>
653 /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
654 /// <li>
655 /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
656 /// </ul>
657 /// </important> <note>
658 /// <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>
659 /// </note>
660 pub fn set_ip_address_type(mut self, input: ::std::option::Option<crate::types::IpAddressType>) -> Self {
661 self.inner = self.inner.set_ip_address_type(input);
662 self
663 }
664 /// <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>
665 /// <p>The <code>IpAddressType</code> parameter has the following limitations:</p>
666 /// <ul>
667 /// <li>
668 /// <p>It cannot be changed while the server is online. You must stop the server before modifying this parameter.</p></li>
669 /// <li>
670 /// <p>It cannot be updated to <code>DUALSTACK</code> if the server has <code>AddressAllocationIds</code> specified.</p></li>
671 /// </ul>
672 /// </important> <note>
673 /// <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>
674 /// </note>
675 pub fn get_ip_address_type(&self) -> &::std::option::Option<crate::types::IpAddressType> {
676 self.inner.get_ip_address_type()
677 }
678}