Struct aws_sdk_storagegateway::operation::update_smb_file_share::builders::UpdateSMBFileShareFluentBuilder

pub struct UpdateSMBFileShareFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateSMBFileShare.

Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.

To leave a file share field unchanged, set the corresponding input field to null.

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 Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

Implementations

impl UpdateSMBFileShareFluentBuilder

pub fn as_input(&self) -> &UpdateSmbFileShareInputBuilder

Access the UpdateSMBFileShare as a reference.

pub async fn send( self ) -> Result<UpdateSmbFileShareOutput, SdkError<UpdateSMBFileShareError, HttpResponse>>

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, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<UpdateSmbFileShareOutput, UpdateSMBFileShareError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn file_share_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

pub fn set_file_share_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

pub fn get_file_share_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

pub fn kms_encrypted(self, input: bool) -> Self

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

pub fn set_kms_encrypted(self, input: Option<bool>) -> Self

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

pub fn get_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

pub fn kms_key(self, input: impl Into<String>) -> Self

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.

pub fn set_kms_key(self, input: Option<String>) -> Self

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.

pub fn get_kms_key(&self) -> &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.

pub fn default_storage_class(self, input: impl Into<String>) -> Self

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

pub fn set_default_storage_class(self, input: Option<String>) -> Self

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

pub fn get_default_storage_class(&self) -> &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

pub fn object_acl(self, input: ObjectAcl) -> Self

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.

pub fn set_object_acl(self, input: Option<ObjectAcl>) -> Self

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.

pub fn get_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.

pub fn read_only(self, input: bool) -> Self

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

pub fn set_read_only(self, input: Option<bool>) -> Self

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

pub fn get_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

pub fn guess_mime_type_enabled(self, input: bool) -> Self

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

pub fn set_guess_mime_type_enabled(self, input: Option<bool>) -> Self

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

pub fn get_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

pub fn requester_pays(self, input: bool) -> Self

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

pub fn set_requester_pays(self, input: Option<bool>) -> Self

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

pub fn get_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

pub fn smbacl_enabled(self, input: bool) -> Self

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

pub fn set_smbacl_enabled(self, input: Option<bool>) -> Self

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

pub fn get_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

pub fn access_based_enumeration(self, input: bool) -> Self

The files and folders on this share will only be visible to users with read access.

pub fn set_access_based_enumeration(self, input: Option<bool>) -> Self

The files and folders on this share will only be visible to users with read access.

pub fn get_access_based_enumeration(&self) -> &Option<bool>

The files and folders on this share will only be visible to users with read access.

pub fn admin_user_list(self, input: impl Into<String>) -> Self

Appends an item to AdminUserList.

To override the contents of this collection use set_admin_user_list.

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.

pub fn set_admin_user_list(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_admin_user_list(&self) -> &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.

pub fn valid_user_list(self, input: impl Into<String>) -> Self

Appends an item to ValidUserList.

To override the contents of this collection use set_valid_user_list.

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.

pub fn set_valid_user_list(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_valid_user_list(&self) -> &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.

pub fn invalid_user_list(self, input: impl Into<String>) -> Self

Appends an item to InvalidUserList.

To override the contents of this collection use set_invalid_user_list.

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.

pub fn set_invalid_user_list(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_invalid_user_list(&self) -> &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.

pub fn audit_destination_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the storage used for audit logs.

pub fn set_audit_destination_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the storage used for audit logs.

pub fn get_audit_destination_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the storage used for audit logs.

pub fn case_sensitivity(self, input: CaseSensitivity) -> Self

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.

pub fn set_case_sensitivity(self, input: Option<CaseSensitivity>) -> Self

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.

pub fn get_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.

pub fn file_share_name(self, input: impl Into<String>) -> Self

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.

pub fn set_file_share_name(self, input: Option<String>) -> Self

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.

pub fn get_file_share_name(&self) -> &Option<String>

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.

pub fn cache_attributes(self, input: CacheAttributes) -> Self

Specifies refresh cache information for the file share.

pub fn set_cache_attributes(self, input: Option<CacheAttributes>) -> Self

Specifies refresh cache information for the file share.

pub fn get_cache_attributes(&self) -> &Option<CacheAttributes>

Specifies refresh cache information for the file share.

pub fn notification_policy(self, input: impl Into<String>) -> Self

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.

{}

pub fn set_notification_policy(self, input: Option<String>) -> Self

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.

{}

pub fn get_notification_policy(&self) -> &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.

{}

pub fn oplocks_enabled(self, input: bool) -> Self

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

pub fn set_oplocks_enabled(self, input: Option<bool>) -> Self

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

pub fn get_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

impl Clone for UpdateSMBFileShareFluentBuilder

fn clone(&self) -> UpdateSMBFileShareFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateSMBFileShareFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.