pub struct CreateSMBFileShareInput {Show 23 fields
pub access_based_enumeration: Option<bool>,
pub admin_user_list: Option<Vec<String>>,
pub audit_destination_arn: Option<String>,
pub authentication: Option<String>,
pub cache_attributes: Option<CacheAttributes>,
pub case_sensitivity: Option<String>,
pub client_token: String,
pub default_storage_class: Option<String>,
pub file_share_name: Option<String>,
pub gateway_arn: String,
pub guess_mime_type_enabled: Option<bool>,
pub invalid_user_list: Option<Vec<String>>,
pub kms_encrypted: Option<bool>,
pub kms_key: Option<String>,
pub location_arn: String,
pub notification_policy: Option<String>,
pub object_acl: Option<String>,
pub read_only: Option<bool>,
pub requester_pays: Option<bool>,
pub role: String,
pub smbacl_enabled: Option<bool>,
pub tags: Option<Vec<Tag>>,
pub valid_user_list: Option<Vec<String>>,
}
Expand description
CreateSMBFileShareInput
Fields
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 will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
.
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
audit_destination_arn: Option<String>
The Amazon Resource Name (ARN) of the storage used for audit logs.
authentication: Option<String>
The authentication method that users use to access the file share. The default is ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
cache_attributes: Option<CacheAttributes>
Specifies refresh cache information for the file share.
case_sensitivity: Option<String>
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
.
client_token: String
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
default_storage_class: Option<String>
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
| S3_STANDARD_IA
| S3_ONEZONE_IA
The name of the file share. Optional.
FileShareName
must be set if an S3 prefix name is set in LocationARN
.
gateway_arn: String
The ARN of the file gateway on which you want to create a file share.
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
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
.
kms_encrypted: Option<bool>
Set to true
to use Amazon S3 server-side encryption with your own AWS 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.
location_arn: String
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
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.
{}
object_acl: Option<String>
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a 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 the write status to read-only, otherwise set to false
.
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
role: String
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
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 AWS Storage Gateway User Guide.
Valid Values: true
| false
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
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
.
Trait Implementations
sourceimpl Clone for CreateSMBFileShareInput
impl Clone for CreateSMBFileShareInput
sourcefn clone(&self) -> CreateSMBFileShareInput
fn clone(&self) -> CreateSMBFileShareInput
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 CreateSMBFileShareInput
impl Debug for CreateSMBFileShareInput
sourceimpl Default for CreateSMBFileShareInput
impl Default for CreateSMBFileShareInput
sourcefn default() -> CreateSMBFileShareInput
fn default() -> CreateSMBFileShareInput
Returns the “default value” for a type. Read more
sourcefn eq(&self, other: &CreateSMBFileShareInput) -> bool
fn eq(&self, other: &CreateSMBFileShareInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateSMBFileShareInput) -> bool
fn ne(&self, other: &CreateSMBFileShareInput) -> bool
This method tests for !=
.
sourceimpl Serialize for CreateSMBFileShareInput
impl Serialize for CreateSMBFileShareInput
impl StructuralPartialEq for CreateSMBFileShareInput
Auto Trait Implementations
impl RefUnwindSafe for CreateSMBFileShareInput
impl Send for CreateSMBFileShareInput
impl Sync for CreateSMBFileShareInput
impl Unpin for CreateSMBFileShareInput
impl UnwindSafe for CreateSMBFileShareInput
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