Struct aws_sdk_storagegateway::model::SmbFileShareInfo

#[non_exhaustive]
pub struct SmbFileShareInfo {

    pub file_share_arn: Option<String>,
    pub file_share_id: Option<String>,
    pub file_share_status: Option<String>,
    pub gateway_arn: Option<String>,
    pub kms_encrypted: bool,
    pub kms_key: Option<String>,
    pub path: Option<String>,
    pub role: Option<String>,
    pub location_arn: 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 authentication: Option<String>,
    pub case_sensitivity: Option<CaseSensitivity>,
    pub tags: Option<Vec<Tag>>,
    pub file_share_name: Option<String>,
    pub cache_attributes: Option<CacheAttributes>,
    pub notification_policy: Option<String>,
    pub vpc_endpoint_dns_name: Option<String>,
    pub bucket_region: Option<String>,
    pub oplocks_enabled: Option<bool>,
}

The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

file_share_arn: Option<String>

The Amazon Resource Name (ARN) of the file share.

file_share_id: Option<String>

The ID of the file share.

file_share_status: Option<String>

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

gateway_arn: Option<String>

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

kms_encrypted: 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.

path: Option<String>

The file share path used by the SMB client to identify the mount point.

role: Option<String>

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

location_arn: Option<String>

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

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 an 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 the 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>

If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

access_based_enumeration: Option<bool>

Indicates whether AccessBasedEnumeration is enabled.

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.

authentication: Option<String>

The authentication method of the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

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.

tags: Option<Vec<Tag>>

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

file_share_name: 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.

cache_attributes: Option<CacheAttributes>

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.

{}

vpc_endpoint_dns_name: Option<String>

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.

bucket_region: Option<String>

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.

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

impl SmbFileShareInfo

pub fn file_share_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the file share.

pub fn file_share_id(&self) -> Option<&str>

The ID of the file share.

pub fn file_share_status(&self) -> Option<&str>

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

pub fn gateway_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

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

pub fn path(&self) -> Option<&str>

The file share path used by the SMB client to identify the mount point.

pub fn role(&self) -> Option<&str>

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

pub fn location_arn(&self) -> Option<&str>

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

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

pub fn object_acl(&self) -> Option<&ObjectAcl>

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

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 the write status to read-only, otherwise set to false.

Valid Values: true | false

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

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

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

If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

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

Indicates whether AccessBasedEnumeration is enabled.

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.

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.

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.

pub fn audit_destination_arn(&self) -> Option<&str>

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

pub fn authentication(&self) -> Option<&str>

The authentication method of the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

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.

pub fn tags(&self) -> Option<&[Tag]>

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

pub fn file_share_name(&self) -> Option<&str>

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) -> Option<&CacheAttributes>

Refresh cache information for the file share.

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.

{}

pub fn vpc_endpoint_dns_name(&self) -> Option<&str>

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.

pub fn bucket_region(&self) -> Option<&str>

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.

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

impl SmbFileShareInfo

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SmbFileShareInfo

Trait Implementations

impl Clone for SmbFileShareInfo

fn clone(&self) -> SmbFileShareInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SmbFileShareInfo

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

Formats the value using the given formatter.

impl PartialEq<SmbFileShareInfo> for SmbFileShareInfo

fn eq(&self, other: &SmbFileShareInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SmbFileShareInfo) -> bool

This method tests for !=.

impl StructuralPartialEq for SmbFileShareInfo