// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_smb_file_share::_update_smb_file_share_input::UpdateSmbFileShareInputBuilder;
pub use crate::operation::update_smb_file_share::_update_smb_file_share_output::UpdateSmbFileShareOutputBuilder;
impl crate::operation::update_smb_file_share::builders::UpdateSmbFileShareInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_smb_file_share::UpdateSMBFileShareError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.update_smb_file_share();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `UpdateSMBFileShare`.
///
/// <p>Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.</p><note>
/// <p>To leave a file share field unchanged, set the corresponding input field to null.</p>
/// </note> <important>
/// <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>
/// <p>File gateways don't support creating hard or symbolic links on a file share.</p>
/// </important>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateSMBFileShareFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_smb_file_share::builders::UpdateSmbFileShareInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
crate::operation::update_smb_file_share::UpdateSMBFileShareError,
> for UpdateSMBFileShareFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
crate::operation::update_smb_file_share::UpdateSMBFileShareError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl UpdateSMBFileShareFluentBuilder {
/// Creates a new `UpdateSMBFileShareFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the UpdateSMBFileShare as a reference.
pub fn as_input(&self) -> &crate::operation::update_smb_file_share::builders::UpdateSmbFileShareInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::update_smb_file_share::UpdateSMBFileShareError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::update_smb_file_share::UpdateSMBFileShare::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::update_smb_file_share::UpdateSMBFileShare::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::update_smb_file_share::UpdateSmbFileShareOutput,
crate::operation::update_smb_file_share::UpdateSMBFileShareError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
pub fn file_share_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.file_share_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
pub fn set_file_share_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_file_share_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
pub fn get_file_share_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_file_share_arn()
}
/// <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>
/// <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>
/// <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>
/// </note>
pub fn encryption_type(mut self, input: crate::types::EncryptionType) -> Self {
self.inner = self.inner.encryption_type(input);
self
}
/// <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>
/// <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>
/// <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>
/// </note>
pub fn set_encryption_type(mut self, input: ::std::option::Option<crate::types::EncryptionType>) -> Self {
self.inner = self.inner.set_encryption_type(input);
self
}
/// <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>
/// <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>
/// <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>
/// </note>
pub fn get_encryption_type(&self) -> &::std::option::Option<crate::types::EncryptionType> {
self.inner.get_encryption_type()
}
/// <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>
/// <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>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
#[deprecated(note = "KMSEncrypted is deprecated, use EncryptionType instead.")]
pub fn kms_encrypted(mut self, input: bool) -> Self {
self.inner = self.inner.kms_encrypted(input);
self
}
/// <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>
/// <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>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
#[deprecated(note = "KMSEncrypted is deprecated, use EncryptionType instead.")]
pub fn set_kms_encrypted(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_kms_encrypted(input);
self
}
/// <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>
/// <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>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
#[deprecated(note = "KMSEncrypted is deprecated, use EncryptionType instead.")]
pub fn get_kms_encrypted(&self) -> &::std::option::Option<bool> {
self.inner.get_kms_encrypted()
}
/// <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>
pub fn kms_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.kms_key(input.into());
self
}
/// <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>
pub fn set_kms_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_kms_key(input);
self
}
/// <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>
pub fn get_kms_key(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_kms_key()
}
/// <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>
/// <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code></p>
pub fn default_storage_class(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.default_storage_class(input.into());
self
}
/// <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>
/// <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code></p>
pub fn set_default_storage_class(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_default_storage_class(input);
self
}
/// <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>
/// <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code></p>
pub fn get_default_storage_class(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_default_storage_class()
}
/// <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>
pub fn object_acl(mut self, input: crate::types::ObjectAcl) -> Self {
self.inner = self.inner.object_acl(input);
self
}
/// <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>
pub fn set_object_acl(mut self, input: ::std::option::Option<crate::types::ObjectAcl>) -> Self {
self.inner = self.inner.set_object_acl(input);
self
}
/// <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>
pub fn get_object_acl(&self) -> &::std::option::Option<crate::types::ObjectAcl> {
self.inner.get_object_acl()
}
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn read_only(mut self, input: bool) -> Self {
self.inner = self.inner.read_only(input);
self
}
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn set_read_only(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_read_only(input);
self
}
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn get_read_only(&self) -> &::std::option::Option<bool> {
self.inner.get_read_only()
}
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn guess_mime_type_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.guess_mime_type_enabled(input);
self
}
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn set_guess_mime_type_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_guess_mime_type_enabled(input);
self
}
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn get_guess_mime_type_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_guess_mime_type_enabled()
}
/// <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>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn requester_pays(mut self, input: bool) -> Self {
self.inner = self.inner.requester_pays(input);
self
}
/// <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>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn set_requester_pays(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_requester_pays(input);
self
}
/// <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>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn get_requester_pays(&self) -> &::std::option::Option<bool> {
self.inner.get_requester_pays()
}
/// <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>
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn smbacl_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.smbacl_enabled(input);
self
}
/// <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>
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn set_smbacl_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_smbacl_enabled(input);
self
}
/// <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>
/// <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>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn get_smbacl_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_smbacl_enabled()
}
/// <p>The files and folders on this share will only be visible to users with read access.</p>
pub fn access_based_enumeration(mut self, input: bool) -> Self {
self.inner = self.inner.access_based_enumeration(input);
self
}
/// <p>The files and folders on this share will only be visible to users with read access.</p>
pub fn set_access_based_enumeration(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_access_based_enumeration(input);
self
}
/// <p>The files and folders on this share will only be visible to users with read access.</p>
pub fn get_access_based_enumeration(&self) -> &::std::option::Option<bool> {
self.inner.get_access_based_enumeration()
}
///
/// Appends an item to `AdminUserList`.
///
/// To override the contents of this collection use [`set_admin_user_list`](Self::set_admin_user_list).
///
/// <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>
pub fn admin_user_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.admin_user_list(input.into());
self
}
/// <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>
pub fn set_admin_user_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_admin_user_list(input);
self
}
/// <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>
pub fn get_admin_user_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_admin_user_list()
}
///
/// Appends an item to `ValidUserList`.
///
/// To override the contents of this collection use [`set_valid_user_list`](Self::set_valid_user_list).
///
/// <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>
pub fn valid_user_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.valid_user_list(input.into());
self
}
/// <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>
pub fn set_valid_user_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_valid_user_list(input);
self
}
/// <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>
pub fn get_valid_user_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_valid_user_list()
}
///
/// Appends an item to `InvalidUserList`.
///
/// To override the contents of this collection use [`set_invalid_user_list`](Self::set_invalid_user_list).
///
/// <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>
pub fn invalid_user_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.invalid_user_list(input.into());
self
}
/// <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>
pub fn set_invalid_user_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_invalid_user_list(input);
self
}
/// <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>
pub fn get_invalid_user_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_invalid_user_list()
}
/// <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
pub fn audit_destination_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.audit_destination_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
pub fn set_audit_destination_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_audit_destination_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
pub fn get_audit_destination_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_audit_destination_arn()
}
/// <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>
pub fn case_sensitivity(mut self, input: crate::types::CaseSensitivity) -> Self {
self.inner = self.inner.case_sensitivity(input);
self
}
/// <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>
pub fn set_case_sensitivity(mut self, input: ::std::option::Option<crate::types::CaseSensitivity>) -> Self {
self.inner = self.inner.set_case_sensitivity(input);
self
}
/// <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>
pub fn get_case_sensitivity(&self) -> &::std::option::Option<crate::types::CaseSensitivity> {
self.inner.get_case_sensitivity()
}
/// <p>The name of the file share. Optional.</p><note>
/// <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>
/// <p>A valid SMB file share name cannot contain the following characters: <code>\[</code>,<code>\]</code>,<code>#</code>,<code>;</code>,<code><</code>,<code>></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>
/// </note>
pub fn file_share_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.file_share_name(input.into());
self
}
/// <p>The name of the file share. Optional.</p><note>
/// <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>
/// <p>A valid SMB file share name cannot contain the following characters: <code>\[</code>,<code>\]</code>,<code>#</code>,<code>;</code>,<code><</code>,<code>></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>
/// </note>
pub fn set_file_share_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_file_share_name(input);
self
}
/// <p>The name of the file share. Optional.</p><note>
/// <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>
/// <p>A valid SMB file share name cannot contain the following characters: <code>\[</code>,<code>\]</code>,<code>#</code>,<code>;</code>,<code><</code>,<code>></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>
/// </note>
pub fn get_file_share_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_file_share_name()
}
/// <p>Specifies refresh cache information for the file share.</p>
pub fn cache_attributes(mut self, input: crate::types::CacheAttributes) -> Self {
self.inner = self.inner.cache_attributes(input);
self
}
/// <p>Specifies refresh cache information for the file share.</p>
pub fn set_cache_attributes(mut self, input: ::std::option::Option<crate::types::CacheAttributes>) -> Self {
self.inner = self.inner.set_cache_attributes(input);
self
}
/// <p>Specifies refresh cache information for the file share.</p>
pub fn get_cache_attributes(&self) -> &::std::option::Option<crate::types::CacheAttributes> {
self.inner.get_cache_attributes()
}
/// <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>
/// <p><code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p>
/// <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>
/// </note>
/// <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p>
/// <p><code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code></p>
/// <p>The following example sets <code>NotificationPolicy</code> off.</p>
/// <p><code>{}</code></p>
pub fn notification_policy(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.notification_policy(input.into());
self
}
/// <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>
/// <p><code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p>
/// <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>
/// </note>
/// <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p>
/// <p><code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code></p>
/// <p>The following example sets <code>NotificationPolicy</code> off.</p>
/// <p><code>{}</code></p>
pub fn set_notification_policy(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_notification_policy(input);
self
}
/// <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>
/// <p><code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p>
/// <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>
/// </note>
/// <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p>
/// <p><code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code></p>
/// <p>The following example sets <code>NotificationPolicy</code> off.</p>
/// <p><code>{}</code></p>
pub fn get_notification_policy(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_notification_policy()
}
/// <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p><note>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn oplocks_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.oplocks_enabled(input);
self
}
/// <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p><note>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn set_oplocks_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_oplocks_enabled(input);
self
}
/// <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p><note>
/// <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>
/// </note>
/// <p>Valid Values: <code>true</code> | <code>false</code></p>
pub fn get_oplocks_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_oplocks_enabled()
}
}