#[non_exhaustive]pub struct UpdateSmbFileShareInput {Show 19 fields
pub file_share_arn: Option<String>,
pub kms_encrypted: Option<bool>,
pub kms_key: Option<String>,
pub default_storage_class: Option<String>,
pub object_acl: Option<ObjectAcl>,
pub read_only: Option<bool>,
pub guess_mime_type_enabled: Option<bool>,
pub requester_pays: Option<bool>,
pub smbacl_enabled: Option<bool>,
pub access_based_enumeration: Option<bool>,
pub admin_user_list: Option<Vec<String>>,
pub valid_user_list: Option<Vec<String>>,
pub invalid_user_list: Option<Vec<String>>,
pub audit_destination_arn: Option<String>,
pub case_sensitivity: Option<CaseSensitivity>,
pub file_share_name: Option<String>,
pub cache_attributes: Option<CacheAttributes>,
pub notification_policy: Option<String>,
pub oplocks_enabled: Option<bool>,
}
Expand description
UpdateSMBFileShareInput
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.The Amazon Resource Name (ARN) of the SMB file share that you want to update.
kms_encrypted: Option<bool>
Set to true
to use Amazon S3 server-side encryption with your own KMS key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
kms_key: Option<String>
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 can only be set when KMSEncrypted
is true
. Optional.
default_storage_class: Option<String>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
| S3_STANDARD_IA
| S3_ONEZONE_IA
object_acl: Option<ObjectAcl>
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 private
.
read_only: Option<bool>
A value that sets the write status of a file share. Set this value to true
to set write status to read-only, otherwise set to false
.
Valid Values: true
| false
guess_mime_type_enabled: Option<bool>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true
to enable MIME type guessing, otherwise set to false
. The default value is true
.
Valid Values: true
| false
requester_pays: Option<bool>
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 true
, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays
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.
Valid Values: true
| false
smbacl_enabled: Option<bool>
Set this value to true
to enable access control list (ACL) on the SMB file share. Set it to false
to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true
| false
access_based_enumeration: Option<bool>
The files and folders on this share will only be visible to users with read access.
admin_user_list: Option<Vec<String>>
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: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to ActiveDirectory
.
valid_user_list: Option<Vec<String>>
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: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to ActiveDirectory
.
invalid_user_list: Option<Vec<String>>
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: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to ActiveDirectory
.
audit_destination_arn: Option<String>
The Amazon Resource Name (ARN) of the storage used for audit logs.
case_sensitivity: Option<CaseSensitivity>
The case of an object name in an Amazon S3 bucket. For ClientSpecified
, the client determines the case sensitivity. For CaseSensitive
, the gateway determines the case sensitivity. The default value is ClientSpecified
.
The name of the file share. Optional.
FileShareName
must be set if an S3 prefix name is set in LocationARN
, or if an access point or access point alias is used.
cache_attributes: Option<CacheAttributes>
Specifies refresh cache information for the file share.
notification_policy: Option<String>
The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded
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.
SettlingTimeInSeconds
has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy
on with SettlingTimeInSeconds
set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy
off.
{}
oplocks_enabled: Option<bool>
Specifies whether opportunistic locking is enabled for the SMB file share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true
| false
Implementations
sourceimpl UpdateSmbFileShareInput
impl UpdateSmbFileShareInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateSMBFileShare, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateSMBFileShare, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<UpdateSMBFileShare
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture UpdateSmbFileShareInput
sourceimpl UpdateSmbFileShareInput
impl UpdateSmbFileShareInput
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
sourcepub fn kms_encrypted(&self) -> Option<bool>
pub fn kms_encrypted(&self) -> Option<bool>
Set to true
to use Amazon S3 server-side encryption with your own KMS key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
sourcepub fn kms_key(&self) -> Option<&str>
pub fn kms_key(&self) -> Option<&str>
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 can only be set when KMSEncrypted
is true
. Optional.
sourcepub fn default_storage_class(&self) -> Option<&str>
pub fn default_storage_class(&self) -> Option<&str>
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
| S3_STANDARD_IA
| S3_ONEZONE_IA
sourcepub fn object_acl(&self) -> Option<&ObjectAcl>
pub fn object_acl(&self) -> Option<&ObjectAcl>
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 private
.
sourcepub fn read_only(&self) -> Option<bool>
pub fn read_only(&self) -> Option<bool>
A value that sets the write status of a file share. Set this value to true
to set write status to read-only, otherwise set to false
.
Valid Values: true
| false
sourcepub fn guess_mime_type_enabled(&self) -> Option<bool>
pub fn guess_mime_type_enabled(&self) -> Option<bool>
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true
to enable MIME type guessing, otherwise set to false
. The default value is true
.
Valid Values: true
| false
sourcepub fn requester_pays(&self) -> Option<bool>
pub fn requester_pays(&self) -> Option<bool>
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 true
, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
RequesterPays
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.
Valid Values: true
| false
sourcepub fn smbacl_enabled(&self) -> Option<bool>
pub fn smbacl_enabled(&self) -> Option<bool>
Set this value to true
to enable access control list (ACL) on the SMB file share. Set it to false
to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true
| false
sourcepub fn access_based_enumeration(&self) -> Option<bool>
pub fn access_based_enumeration(&self) -> Option<bool>
The files and folders on this share will only be visible to users with read access.
sourcepub fn admin_user_list(&self) -> Option<&[String]>
pub fn admin_user_list(&self) -> Option<&[String]>
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: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to ActiveDirectory
.
sourcepub fn valid_user_list(&self) -> Option<&[String]>
pub fn valid_user_list(&self) -> Option<&[String]>
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: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to ActiveDirectory
.
sourcepub fn invalid_user_list(&self) -> Option<&[String]>
pub fn invalid_user_list(&self) -> Option<&[String]>
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: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to ActiveDirectory
.
sourcepub fn audit_destination_arn(&self) -> Option<&str>
pub fn audit_destination_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the storage used for audit logs.
sourcepub fn case_sensitivity(&self) -> Option<&CaseSensitivity>
pub fn case_sensitivity(&self) -> Option<&CaseSensitivity>
The case of an object name in an Amazon S3 bucket. For ClientSpecified
, the client determines the case sensitivity. For CaseSensitive
, the gateway determines the case sensitivity. The default value is ClientSpecified
.
The name of the file share. Optional.
FileShareName
must be set if an S3 prefix name is set in LocationARN
, or if an access point or access point alias is used.
sourcepub fn cache_attributes(&self) -> Option<&CacheAttributes>
pub fn cache_attributes(&self) -> Option<&CacheAttributes>
Specifies refresh cache information for the file share.
sourcepub fn notification_policy(&self) -> Option<&str>
pub fn notification_policy(&self) -> Option<&str>
The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded
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.
SettlingTimeInSeconds
has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy
on with SettlingTimeInSeconds
set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy
off.
{}
sourcepub fn oplocks_enabled(&self) -> Option<bool>
pub fn oplocks_enabled(&self) -> Option<bool>
Specifies whether opportunistic locking is enabled for the SMB file share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true
| false
Trait Implementations
sourceimpl Clone for UpdateSmbFileShareInput
impl Clone for UpdateSmbFileShareInput
sourcefn clone(&self) -> UpdateSmbFileShareInput
fn clone(&self) -> UpdateSmbFileShareInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateSmbFileShareInput
impl Debug for UpdateSmbFileShareInput
sourcefn eq(&self, other: &UpdateSmbFileShareInput) -> bool
fn eq(&self, other: &UpdateSmbFileShareInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateSmbFileShareInput) -> bool
fn ne(&self, other: &UpdateSmbFileShareInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for UpdateSmbFileShareInput
Auto Trait Implementations
impl RefUnwindSafe for UpdateSmbFileShareInput
impl Send for UpdateSmbFileShareInput
impl Sync for UpdateSmbFileShareInput
impl Unpin for UpdateSmbFileShareInput
impl UnwindSafe for UpdateSmbFileShareInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more