pub struct CreateSMBFileShare { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateSMBFileShare
.
Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.
S3 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 S3 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
sourceimpl CreateSMBFileShare
impl CreateSMBFileShare
sourcepub async fn send(
self
) -> Result<CreateSmbFileShareOutput, SdkError<CreateSMBFileShareError>>
pub async fn send(
self
) -> Result<CreateSmbFileShareOutput, SdkError<CreateSMBFileShareError>>
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.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
sourcepub fn gateway_arn(self, input: impl Into<String>) -> Self
pub fn gateway_arn(self, input: impl Into<String>) -> Self
The ARN of the S3 File Gateway on which you want to create a file share.
sourcepub fn set_gateway_arn(self, input: Option<String>) -> Self
pub fn set_gateway_arn(self, input: Option<String>) -> Self
The ARN of the S3 File Gateway on which you want to create a file share.
sourcepub fn kms_encrypted(self, input: bool) -> Self
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
sourcepub fn set_kms_encrypted(self, input: Option<bool>) -> Self
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
sourcepub fn kms_key(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_kms_key(self, input: Option<String>) -> Self
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.
sourcepub fn role(self, input: impl Into<String>) -> Self
pub fn role(self, input: impl Into<String>) -> Self
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
sourcepub fn set_role(self, input: Option<String>) -> Self
pub fn set_role(self, input: Option<String>) -> Self
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
sourcepub fn location_arn(self, input: impl Into<String>) -> Self
pub fn location_arn(self, input: impl Into<String>) -> Self
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
sourcepub fn set_location_arn(self, input: Option<String>) -> Self
pub fn set_location_arn(self, input: Option<String>) -> Self
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
sourcepub fn default_storage_class(self, input: impl Into<String>) -> Self
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
sourcepub fn set_default_storage_class(self, input: Option<String>) -> Self
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
sourcepub fn object_acl(self, input: ObjectAcl) -> Self
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
.
sourcepub fn set_object_acl(self, input: Option<ObjectAcl>) -> Self
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
.
sourcepub fn read_only(self, input: bool) -> Self
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 the write status to read-only, otherwise set to false
.
Valid Values: true
| false
sourcepub fn set_read_only(self, input: Option<bool>) -> Self
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 the write status to read-only, otherwise set to false
.
Valid Values: true
| false
sourcepub fn guess_mime_type_enabled(self, input: bool) -> Self
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
sourcepub fn set_guess_mime_type_enabled(self, input: Option<bool>) -> Self
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
sourcepub fn requester_pays(self, input: bool) -> Self
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
sourcepub fn set_requester_pays(self, input: Option<bool>) -> Self
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
sourcepub fn smbacl_enabled(self, input: bool) -> Self
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
sourcepub fn set_smbacl_enabled(self, input: Option<bool>) -> Self
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
sourcepub fn access_based_enumeration(self, input: bool) -> Self
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.
sourcepub fn set_access_based_enumeration(self, input: Option<bool>) -> Self
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.
sourcepub fn admin_user_list(self, input: impl Into<String>) -> Self
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 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.
sourcepub fn set_admin_user_list(self, input: Option<Vec<String>>) -> Self
pub fn set_admin_user_list(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn valid_user_list(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_valid_user_list(self, input: Option<Vec<String>>) -> Self
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
.
sourcepub fn invalid_user_list(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_invalid_user_list(self, input: Option<Vec<String>>) -> Self
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
.
sourcepub fn audit_destination_arn(self, input: impl Into<String>) -> Self
pub fn audit_destination_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the storage used for audit logs.
sourcepub fn set_audit_destination_arn(self, input: Option<String>) -> Self
pub fn set_audit_destination_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the storage used for audit logs.
sourcepub fn authentication(self, input: impl Into<String>) -> Self
pub fn authentication(self, input: impl Into<String>) -> Self
The authentication method that users use to access the file share. The default is ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
sourcepub fn set_authentication(self, input: Option<String>) -> Self
pub fn set_authentication(self, input: Option<String>) -> Self
The authentication method that users use to access the file share. The default is ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
sourcepub fn case_sensitivity(self, input: CaseSensitivity) -> Self
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
.
sourcepub fn set_case_sensitivity(self, input: Option<CaseSensitivity>) -> Self
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
.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
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, input: CacheAttributes) -> Self
pub fn cache_attributes(self, input: CacheAttributes) -> Self
Specifies refresh cache information for the file share.
sourcepub fn set_cache_attributes(self, input: Option<CacheAttributes>) -> Self
pub fn set_cache_attributes(self, input: Option<CacheAttributes>) -> Self
Specifies refresh cache information for the file share.
sourcepub fn notification_policy(self, input: impl Into<String>) -> Self
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.
{}
sourcepub fn set_notification_policy(self, input: Option<String>) -> Self
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.
{}
sourcepub fn vpc_endpoint_dns_name(self, input: impl Into<String>) -> Self
pub fn vpc_endpoint_dns_name(self, input: impl Into<String>) -> Self
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
sourcepub fn set_vpc_endpoint_dns_name(self, input: Option<String>) -> Self
pub fn set_vpc_endpoint_dns_name(self, input: Option<String>) -> Self
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
sourcepub fn bucket_region(self, input: impl Into<String>) -> Self
pub fn bucket_region(self, input: impl Into<String>) -> Self
Specifies the Region of the S3 bucket where the SMB file share stores files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
sourcepub fn set_bucket_region(self, input: Option<String>) -> Self
pub fn set_bucket_region(self, input: Option<String>) -> Self
Specifies the Region of the S3 bucket where the SMB file share stores files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
sourcepub fn oplocks_enabled(self, input: bool) -> Self
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
sourcepub fn set_oplocks_enabled(self, input: Option<bool>) -> Self
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
Trait Implementations
sourceimpl Clone for CreateSMBFileShare
impl Clone for CreateSMBFileShare
sourcefn clone(&self) -> CreateSMBFileShare
fn clone(&self) -> CreateSMBFileShare
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
Auto Trait Implementations
impl !RefUnwindSafe for CreateSMBFileShare
impl Send for CreateSMBFileShare
impl Sync for CreateSMBFileShare
impl Unpin for CreateSMBFileShare
impl !UnwindSafe for CreateSMBFileShare
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