#[non_exhaustive]pub struct UpdateSmbFileShareInput {Show 20 fields
pub file_share_arn: Option<String>,
pub encryption_type: Option<EncryptionType>,
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.
encryption_type: Option<EncryptionType>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.
We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.
kms_encrypted: Option<bool>Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.
Valid Values: true | false
kms_key: Option<String>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 KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
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 Windows ACLs to limit SMB file share access in the Amazon S3 File 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.
A valid SMB file share name cannot contain the following characters: \[,\],#,;,<,>,:,",\,/,|,?,*,+, or ASCII control characters 1-31.
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.
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.
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§
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
Sourcepub fn encryption_type(&self) -> Option<&EncryptionType>
pub fn encryption_type(&self) -> Option<&EncryptionType>
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.
We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.
Sourcepub fn kms_encrypted(&self) -> Option<bool>
👎Deprecated: KMSEncrypted is deprecated, use EncryptionType instead.
pub fn kms_encrypted(&self) -> Option<bool>
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.
If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.
Valid Values: true | false
Sourcepub fn kms_key(&self) -> Option<&str>
pub fn kms_key(&self) -> Option<&str>
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 KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
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 Windows ACLs to limit SMB file share access in the Amazon S3 File 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) -> &[String]
pub fn admin_user_list(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .admin_user_list.is_none().
Sourcepub fn valid_user_list(&self) -> &[String]
pub fn valid_user_list(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .valid_user_list.is_none().
Sourcepub fn invalid_user_list(&self) -> &[String]
pub fn invalid_user_list(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .invalid_user_list.is_none().
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.
A valid SMB file share name cannot contain the following characters: \[,\],#,;,<,>,:,",\,/,|,?,*,+, or ASCII control characters 1-31.
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.
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.
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
Sourcepub fn builder() -> UpdateSmbFileShareInputBuilder
pub fn builder() -> UpdateSmbFileShareInputBuilder
Creates a new builder-style object to manufacture UpdateSmbFileShareInput.
Trait Implementations§
Source§fn clone(&self) -> UpdateSmbFileShareInput
fn clone(&self) -> UpdateSmbFileShareInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);