aws_sdk_storagegateway/operation/update_smb_file_share/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_smb_file_share::_update_smb_file_share_output::UpdateSmbFileShareOutputBuilder;
3
4pub use crate::operation::update_smb_file_share::_update_smb_file_share_input::UpdateSmbFileShareInputBuilder;
5
6impl crate::operation::update_smb_file_share::builders::UpdateSmbFileShareInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_smb_file_share::UpdateSMBFileShareError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_smb_file_share();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateSMBFileShare`.
24///
25/// <p>Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.</p><note>
26/// <p>To leave a file share field unchanged, set the corresponding input field to null.</p>
27/// </note> <important>
28/// <p>File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>Identity and Access Management User Guide</i>.</p>
29/// <p>File gateways don't support creating hard or symbolic links on a file share.</p>
30/// </important>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct UpdateSMBFileShareFluentBuilder {
33    handle: ::std::sync::Arc<crate::client::Handle>,
34    inner: crate::operation::update_smb_file_share::builders::UpdateSmbFileShareInputBuilder,
35    config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38    crate::client::customize::internal::CustomizableSend<
39        crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
40        crate::operation::update_smb_file_share::UpdateSMBFileShareError,
41    > for UpdateSMBFileShareFluentBuilder
42{
43    fn send(
44        self,
45        config_override: crate::config::Builder,
46    ) -> crate::client::customize::internal::BoxFuture<
47        crate::client::customize::internal::SendResult<
48            crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
49            crate::operation::update_smb_file_share::UpdateSMBFileShareError,
50        >,
51    > {
52        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53    }
54}
55impl UpdateSMBFileShareFluentBuilder {
56    /// Creates a new `UpdateSMBFileShareFluentBuilder`.
57    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58        Self {
59            handle,
60            inner: ::std::default::Default::default(),
61            config_override: ::std::option::Option::None,
62        }
63    }
64    /// Access the UpdateSMBFileShare as a reference.
65    pub fn as_input(&self) -> &crate::operation::update_smb_file_share::builders::UpdateSmbFileShareInputBuilder {
66        &self.inner
67    }
68    /// Sends the request and returns the response.
69    ///
70    /// If an error occurs, an `SdkError` will be returned with additional details that
71    /// can be matched against.
72    ///
73    /// By default, any retryable failures will be retried twice. Retry behavior
74    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75    /// set when configuring the client.
76    pub async fn send(
77        self,
78    ) -> ::std::result::Result<
79        crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
80        ::aws_smithy_runtime_api::client::result::SdkError<
81            crate::operation::update_smb_file_share::UpdateSMBFileShareError,
82            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83        >,
84    > {
85        let input = self
86            .inner
87            .build()
88            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89        let runtime_plugins = crate::operation::update_smb_file_share::UpdateSMBFileShare::operation_runtime_plugins(
90            self.handle.runtime_plugins.clone(),
91            &self.handle.conf,
92            self.config_override,
93        );
94        crate::operation::update_smb_file_share::UpdateSMBFileShare::orchestrate(&runtime_plugins, input).await
95    }
96
97    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98    pub fn customize(
99        self,
100    ) -> crate::client::customize::CustomizableOperation<
101        crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
102        crate::operation::update_smb_file_share::UpdateSMBFileShareError,
103        Self,
104    > {
105        crate::client::customize::CustomizableOperation::new(self)
106    }
107    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108        self.set_config_override(::std::option::Option::Some(config_override.into()));
109        self
110    }
111
112    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113        self.config_override = config_override;
114        self
115    }
116    /// <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
117    pub fn file_share_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.inner = self.inner.file_share_arn(input.into());
119        self
120    }
121    /// <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
122    pub fn set_file_share_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.inner = self.inner.set_file_share_arn(input);
124        self
125    }
126    /// <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
127    pub fn get_file_share_arn(&self) -> &::std::option::Option<::std::string::String> {
128        self.inner.get_file_share_arn()
129    }
130    /// <p>A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.</p><note>
131    /// <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p>
132    /// <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p>
133    /// </note>
134    pub fn encryption_type(mut self, input: crate::types::EncryptionType) -> Self {
135        self.inner = self.inner.encryption_type(input);
136        self
137    }
138    /// <p>A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.</p><note>
139    /// <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p>
140    /// <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p>
141    /// </note>
142    pub fn set_encryption_type(mut self, input: ::std::option::Option<crate::types::EncryptionType>) -> Self {
143        self.inner = self.inner.set_encryption_type(input);
144        self
145    }
146    /// <p>A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.</p><note>
147    /// <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p>
148    /// <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p>
149    /// </note>
150    pub fn get_encryption_type(&self) -> &::std::option::Option<crate::types::EncryptionType> {
151        self.inner.get_encryption_type()
152    }
153    /// <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the <code>EncryptionType</code> parameter instead.</p><note>
154    /// <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p>
155    /// <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p>
156    /// </note>
157    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
158    #[deprecated(note = "KMSEncrypted is deprecated, use EncryptionType instead.")]
159    pub fn kms_encrypted(mut self, input: bool) -> Self {
160        self.inner = self.inner.kms_encrypted(input);
161        self
162    }
163    /// <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the <code>EncryptionType</code> parameter instead.</p><note>
164    /// <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p>
165    /// <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p>
166    /// </note>
167    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
168    #[deprecated(note = "KMSEncrypted is deprecated, use EncryptionType instead.")]
169    pub fn set_kms_encrypted(mut self, input: ::std::option::Option<bool>) -> Self {
170        self.inner = self.inner.set_kms_encrypted(input);
171        self
172    }
173    /// <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the <code>EncryptionType</code> parameter instead.</p><note>
174    /// <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p>
175    /// <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p>
176    /// </note>
177    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
178    #[deprecated(note = "KMSEncrypted is deprecated, use EncryptionType instead.")]
179    pub fn get_kms_encrypted(&self) -> &::std::option::Option<bool> {
180        self.inner.get_kms_encrypted()
181    }
182    /// <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
183    pub fn kms_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
184        self.inner = self.inner.kms_key(input.into());
185        self
186    }
187    /// <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
188    pub fn set_kms_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
189        self.inner = self.inner.set_kms_key(input);
190        self
191    }
192    /// <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
193    pub fn get_kms_key(&self) -> &::std::option::Option<::std::string::String> {
194        self.inner.get_kms_key()
195    }
196    /// <p>The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
197    /// <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code></p>
198    pub fn default_storage_class(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
199        self.inner = self.inner.default_storage_class(input.into());
200        self
201    }
202    /// <p>The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
203    /// <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code></p>
204    pub fn set_default_storage_class(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
205        self.inner = self.inner.set_default_storage_class(input);
206        self
207    }
208    /// <p>The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
209    /// <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code></p>
210    pub fn get_default_storage_class(&self) -> &::std::option::Option<::std::string::String> {
211        self.inner.get_default_storage_class()
212    }
213    /// <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
214    pub fn object_acl(mut self, input: crate::types::ObjectAcl) -> Self {
215        self.inner = self.inner.object_acl(input);
216        self
217    }
218    /// <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
219    pub fn set_object_acl(mut self, input: ::std::option::Option<crate::types::ObjectAcl>) -> Self {
220        self.inner = self.inner.set_object_acl(input);
221        self
222    }
223    /// <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
224    pub fn get_object_acl(&self) -> &::std::option::Option<crate::types::ObjectAcl> {
225        self.inner.get_object_acl()
226    }
227    /// <p>A value that sets the write status of a file share. Set this value to <code>true</code> to set write status to read-only, otherwise set to <code>false</code>.</p>
228    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
229    pub fn read_only(mut self, input: bool) -> Self {
230        self.inner = self.inner.read_only(input);
231        self
232    }
233    /// <p>A value that sets the write status of a file share. Set this value to <code>true</code> to set write status to read-only, otherwise set to <code>false</code>.</p>
234    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
235    pub fn set_read_only(mut self, input: ::std::option::Option<bool>) -> Self {
236        self.inner = self.inner.set_read_only(input);
237        self
238    }
239    /// <p>A value that sets the write status of a file share. Set this value to <code>true</code> to set write status to read-only, otherwise set to <code>false</code>.</p>
240    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
241    pub fn get_read_only(&self) -> &::std::option::Option<bool> {
242        self.inner.get_read_only()
243    }
244    /// <p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set to <code>false</code>. The default value is <code>true</code>.</p>
245    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
246    pub fn guess_mime_type_enabled(mut self, input: bool) -> Self {
247        self.inner = self.inner.guess_mime_type_enabled(input);
248        self
249    }
250    /// <p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set to <code>false</code>. The default value is <code>true</code>.</p>
251    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
252    pub fn set_guess_mime_type_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
253        self.inner = self.inner.set_guess_mime_type_enabled(input);
254        self
255    }
256    /// <p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set to <code>false</code>. The default value is <code>true</code>.</p>
257    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
258    pub fn get_guess_mime_type_enabled(&self) -> &::std::option::Option<bool> {
259        self.inner.get_guess_mime_type_enabled()
260    }
261    /// <p>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to <code>true</code>, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</p><note>
262    /// <p><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</p>
263    /// </note>
264    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
265    pub fn requester_pays(mut self, input: bool) -> Self {
266        self.inner = self.inner.requester_pays(input);
267        self
268    }
269    /// <p>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to <code>true</code>, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</p><note>
270    /// <p><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</p>
271    /// </note>
272    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
273    pub fn set_requester_pays(mut self, input: ::std::option::Option<bool>) -> Self {
274        self.inner = self.inner.set_requester_pays(input);
275        self
276    }
277    /// <p>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to <code>true</code>, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</p><note>
278    /// <p><code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</p>
279    /// </note>
280    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
281    pub fn get_requester_pays(&self) -> &::std::option::Option<bool> {
282        self.inner.get_requester_pays()
283    }
284    /// <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file share. Set it to <code>false</code> to map file and directory permissions to the POSIX permissions.</p>
285    /// <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html">Using Windows ACLs to limit SMB file share access</a> in the <i>Amazon S3 File Gateway User Guide</i>.</p>
286    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
287    pub fn smbacl_enabled(mut self, input: bool) -> Self {
288        self.inner = self.inner.smbacl_enabled(input);
289        self
290    }
291    /// <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file share. Set it to <code>false</code> to map file and directory permissions to the POSIX permissions.</p>
292    /// <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html">Using Windows ACLs to limit SMB file share access</a> in the <i>Amazon S3 File Gateway User Guide</i>.</p>
293    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
294    pub fn set_smbacl_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
295        self.inner = self.inner.set_smbacl_enabled(input);
296        self
297    }
298    /// <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file share. Set it to <code>false</code> to map file and directory permissions to the POSIX permissions.</p>
299    /// <p>For more information, see <a href="https://docs.aws.amazon.com/filegateway/latest/files3/smb-acl.html">Using Windows ACLs to limit SMB file share access</a> in the <i>Amazon S3 File Gateway User Guide</i>.</p>
300    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
301    pub fn get_smbacl_enabled(&self) -> &::std::option::Option<bool> {
302        self.inner.get_smbacl_enabled()
303    }
304    /// <p>The files and folders on this share will only be visible to users with read access.</p>
305    pub fn access_based_enumeration(mut self, input: bool) -> Self {
306        self.inner = self.inner.access_based_enumeration(input);
307        self
308    }
309    /// <p>The files and folders on this share will only be visible to users with read access.</p>
310    pub fn set_access_based_enumeration(mut self, input: ::std::option::Option<bool>) -> Self {
311        self.inner = self.inner.set_access_based_enumeration(input);
312        self
313    }
314    /// <p>The files and folders on this share will only be visible to users with read access.</p>
315    pub fn get_access_based_enumeration(&self) -> &::std::option::Option<bool> {
316        self.inner.get_access_based_enumeration()
317    }
318    ///
319    /// Appends an item to `AdminUserList`.
320    ///
321    /// To override the contents of this collection use [`set_admin_user_list`](Self::set_admin_user_list).
322    ///
323    /// <p>A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
324    pub fn admin_user_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
325        self.inner = self.inner.admin_user_list(input.into());
326        self
327    }
328    /// <p>A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
329    pub fn set_admin_user_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
330        self.inner = self.inner.set_admin_user_list(input);
331        self
332    }
333    /// <p>A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
334    pub fn get_admin_user_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
335        self.inner.get_admin_user_list()
336    }
337    ///
338    /// Appends an item to `ValidUserList`.
339    ///
340    /// To override the contents of this collection use [`set_valid_user_list`](Self::set_valid_user_list).
341    ///
342    /// <p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
343    pub fn valid_user_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
344        self.inner = self.inner.valid_user_list(input.into());
345        self
346    }
347    /// <p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
348    pub fn set_valid_user_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
349        self.inner = self.inner.set_valid_user_list(input);
350        self
351    }
352    /// <p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
353    pub fn get_valid_user_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
354        self.inner.get_valid_user_list()
355    }
356    ///
357    /// Appends an item to `InvalidUserList`.
358    ///
359    /// To override the contents of this collection use [`set_invalid_user_list`](Self::set_invalid_user_list).
360    ///
361    /// <p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
362    pub fn invalid_user_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
363        self.inner = self.inner.invalid_user_list(input.into());
364        self
365    }
366    /// <p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
367    pub fn set_invalid_user_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
368        self.inner = self.inner.set_invalid_user_list(input);
369        self
370    }
371    /// <p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>
372    pub fn get_invalid_user_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
373        self.inner.get_invalid_user_list()
374    }
375    /// <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
376    pub fn audit_destination_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
377        self.inner = self.inner.audit_destination_arn(input.into());
378        self
379    }
380    /// <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
381    pub fn set_audit_destination_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
382        self.inner = self.inner.set_audit_destination_arn(input);
383        self
384    }
385    /// <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
386    pub fn get_audit_destination_arn(&self) -> &::std::option::Option<::std::string::String> {
387        self.inner.get_audit_destination_arn()
388    }
389    /// <p>The case of an object name in an Amazon S3 bucket. For <code>ClientSpecified</code>, the client determines the case sensitivity. For <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default value is <code>ClientSpecified</code>.</p>
390    pub fn case_sensitivity(mut self, input: crate::types::CaseSensitivity) -> Self {
391        self.inner = self.inner.case_sensitivity(input);
392        self
393    }
394    /// <p>The case of an object name in an Amazon S3 bucket. For <code>ClientSpecified</code>, the client determines the case sensitivity. For <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default value is <code>ClientSpecified</code>.</p>
395    pub fn set_case_sensitivity(mut self, input: ::std::option::Option<crate::types::CaseSensitivity>) -> Self {
396        self.inner = self.inner.set_case_sensitivity(input);
397        self
398    }
399    /// <p>The case of an object name in an Amazon S3 bucket. For <code>ClientSpecified</code>, the client determines the case sensitivity. For <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default value is <code>ClientSpecified</code>.</p>
400    pub fn get_case_sensitivity(&self) -> &::std::option::Option<crate::types::CaseSensitivity> {
401        self.inner.get_case_sensitivity()
402    }
403    /// <p>The name of the file share. Optional.</p><note>
404    /// <p><code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>, or if an access point or access point alias is used.</p>
405    /// <p>A valid SMB file share name cannot contain the following characters: <code>\[</code>,<code>\]</code>,<code>#</code>,<code>;</code>,<code>&lt;</code>,<code>&gt;</code>,<code>:</code>,<code>"</code>,<code>\</code>,<code>/</code>,<code>|</code>,<code>?</code>,<code>*</code>,<code>+</code>, or ASCII control characters <code>1-31</code>.</p>
406    /// </note>
407    pub fn file_share_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
408        self.inner = self.inner.file_share_name(input.into());
409        self
410    }
411    /// <p>The name of the file share. Optional.</p><note>
412    /// <p><code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>, or if an access point or access point alias is used.</p>
413    /// <p>A valid SMB file share name cannot contain the following characters: <code>\[</code>,<code>\]</code>,<code>#</code>,<code>;</code>,<code>&lt;</code>,<code>&gt;</code>,<code>:</code>,<code>"</code>,<code>\</code>,<code>/</code>,<code>|</code>,<code>?</code>,<code>*</code>,<code>+</code>, or ASCII control characters <code>1-31</code>.</p>
414    /// </note>
415    pub fn set_file_share_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
416        self.inner = self.inner.set_file_share_name(input);
417        self
418    }
419    /// <p>The name of the file share. Optional.</p><note>
420    /// <p><code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>, or if an access point or access point alias is used.</p>
421    /// <p>A valid SMB file share name cannot contain the following characters: <code>\[</code>,<code>\]</code>,<code>#</code>,<code>;</code>,<code>&lt;</code>,<code>&gt;</code>,<code>:</code>,<code>"</code>,<code>\</code>,<code>/</code>,<code>|</code>,<code>?</code>,<code>*</code>,<code>+</code>, or ASCII control characters <code>1-31</code>.</p>
422    /// </note>
423    pub fn get_file_share_name(&self) -> &::std::option::Option<::std::string::String> {
424        self.inner.get_file_share_name()
425    }
426    /// <p>Specifies refresh cache information for the file share.</p>
427    pub fn cache_attributes(mut self, input: crate::types::CacheAttributes) -> Self {
428        self.inner = self.inner.cache_attributes(input);
429        self
430    }
431    /// <p>Specifies refresh cache information for the file share.</p>
432    pub fn set_cache_attributes(mut self, input: ::std::option::Option<crate::types::CacheAttributes>) -> Self {
433        self.inner = self.inner.set_cache_attributes(input);
434        self
435    }
436    /// <p>Specifies refresh cache information for the file share.</p>
437    pub fn get_cache_attributes(&self) -> &::std::option::Option<crate::types::CacheAttributes> {
438        self.inner.get_cache_attributes()
439    }
440    /// <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls the number of seconds to wait after the last point in time a client wrote to a file before generating an <code>ObjectUploaded</code> notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.</p><note>
441    /// <p><code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p>
442    /// <p>This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.</p>
443    /// </note>
444    /// <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p>
445    /// <p><code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code></p>
446    /// <p>The following example sets <code>NotificationPolicy</code> off.</p>
447    /// <p><code>{}</code></p>
448    pub fn notification_policy(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
449        self.inner = self.inner.notification_policy(input.into());
450        self
451    }
452    /// <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls the number of seconds to wait after the last point in time a client wrote to a file before generating an <code>ObjectUploaded</code> notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.</p><note>
453    /// <p><code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p>
454    /// <p>This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.</p>
455    /// </note>
456    /// <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p>
457    /// <p><code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code></p>
458    /// <p>The following example sets <code>NotificationPolicy</code> off.</p>
459    /// <p><code>{}</code></p>
460    pub fn set_notification_policy(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
461        self.inner = self.inner.set_notification_policy(input);
462        self
463    }
464    /// <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls the number of seconds to wait after the last point in time a client wrote to a file before generating an <code>ObjectUploaded</code> notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.</p><note>
465    /// <p><code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p>
466    /// <p>This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.</p>
467    /// </note>
468    /// <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p>
469    /// <p><code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code></p>
470    /// <p>The following example sets <code>NotificationPolicy</code> off.</p>
471    /// <p><code>{}</code></p>
472    pub fn get_notification_policy(&self) -> &::std::option::Option<::std::string::String> {
473        self.inner.get_notification_policy()
474    }
475    /// <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p><note>
476    /// <p>Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.</p>
477    /// </note>
478    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
479    pub fn oplocks_enabled(mut self, input: bool) -> Self {
480        self.inner = self.inner.oplocks_enabled(input);
481        self
482    }
483    /// <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p><note>
484    /// <p>Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.</p>
485    /// </note>
486    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
487    pub fn set_oplocks_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
488        self.inner = self.inner.set_oplocks_enabled(input);
489        self
490    }
491    /// <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p><note>
492    /// <p>Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.</p>
493    /// </note>
494    /// <p>Valid Values: <code>true</code> | <code>false</code></p>
495    pub fn get_oplocks_enabled(&self) -> &::std::option::Option<bool> {
496        self.inner.get_oplocks_enabled()
497    }
498}