SmbFileShareState class
Input properties used for looking up and filtering SmbFileShare resources.
Constructors
-
Creates a new SmbFileShareState.
accessBasedEnumerationThe files and folders on this share will only be visible to users with read access. Default value isfalse.adminUserListsA list of users in the Active Directory that have admin access to the file share. Only valid ifauthenticationis set toActiveDirectory.arnARN of the SMB File Share.auditDestinationArnARN of the CloudWatch Log Group used for the audit logs.authenticationThe authentication method that users use to access the file share. Defaults toActiveDirectory. Valid values:ActiveDirectory,GuestAccess.bucketRegionThe region of the S3 buck used by the file share. Required when specifying avpcEndpointDnsName.cacheAttributesRefresh cache information. seecacheAttributesBlock for more details.caseSensitivityThe case of an object name in an Amazon S3 bucket. ForClientSpecified, the client determines the case sensitivity. ForCaseSensitive, the gateway determines the case sensitivity. The default value isClientSpecified.defaultStorageClassThe default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults toS3_STANDARD.fileShareNameThe name of the file share. Must be set if an S3 prefix name is set inlocationArn.fileshareIdID of the SMB File Share.gatewayArnARN of the file gateway.guessMimeTypeEnabledBoolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults totrue.invalidUserListsA list of users in the Active Directory that are not allowed to access the file share. Only valid ifauthenticationis set toActiveDirectory.kmsEncryptedBoolean value iftrueto use Amazon S3 server side encryption with your own AWS KMS key, orfalseto use a key managed by Amazon S3. Defaults tofalse.kmsKeyArnARN for KMS key used for Amazon S3 server side encryption. This value can only be set whenkmsEncryptedis true.locationArnThe ARN of the backed storage used for storing file data.notificationPolicyThe notification policy of the file share. For more information see the AWS Documentation. Default value is{}.objectAclAccess Control List permission for S3 objects. Defaults toprivate.oplocksEnabledBoolean to indicate Opportunistic lock (oplock) status. Defaults totrue.pathFile share path used by the NFS client to identify the mount point.readOnlyBoolean to indicate write status of file share. File share does not accept writes iftrue. Defaults tofalse.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requesterPaysBoolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value totrueif you want the requester to pay instead of the bucket owner. Defaults tofalse.roleArnThe ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.smbAclEnabledSet this value totrueto enable ACL (access control list) on the SMB fileshare. Set it tofalseto map file and directory permissions to the POSIX permissions. This setting applies only toActiveDirectoryauthentication type.tagsKey-value map of resource tags. .If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.validUserListsA list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid ifauthenticationis set toActiveDirectory.vpcEndpointDnsNameThe DNS name of the VPC endpoint for S3 private link.const -
factory
Properties
-
accessBasedEnumeration
→ Input<
bool?> ? -
The files and folders on this share will only be visible to users with read access. Default value is
false.final -
adminUserLists
→ Input<
List< ?String> ?> -
A list of users in the Active Directory that have admin access to the file share. Only valid if
authenticationis set toActiveDirectory.final -
arn
→ Input<
String?> ? -
ARN of the SMB File Share.
final
-
auditDestinationArn
→ Input<
String?> ? -
ARN of the CloudWatch Log Group used for the audit logs.
final
-
authentication
→ Input<
String?> ? -
The authentication method that users use to access the file share. Defaults to
ActiveDirectory. Valid values:ActiveDirectory,GuestAccess.final -
bucketRegion
→ Input<
String?> ? -
The region of the S3 buck used by the file share. Required when specifying a
vpcEndpointDnsName.final -
cacheAttributes
→ Input<
SmbFileShareCacheAttributes?> ? -
Refresh cache information. see
cacheAttributesBlock for more details.final -
caseSensitivity
→ Input<
String?> ? -
The case of an object name in an Amazon S3 bucket. For
ClientSpecified, the client determines the case sensitivity. ForCaseSensitive, the gateway determines the case sensitivity. The default value isClientSpecified.final -
defaultStorageClass
→ Input<
String?> ? -
The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to
S3_STANDARD.final -
ID of the SMB File Share.
final
-
The name of the file share. Must be set if an S3 prefix name is set in
locationArn.final -
gatewayArn
→ Input<
String?> ? -
ARN of the file gateway.
final
-
guessMimeTypeEnabled
→ Input<
bool?> ? -
Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to
true.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
invalidUserLists
→ Input<
List< ?String> ?> -
A list of users in the Active Directory that are not allowed to access the file share. Only valid if
authenticationis set toActiveDirectory.final -
kmsEncrypted
→ Input<
bool?> ? -
Boolean value if
trueto use Amazon S3 server side encryption with your own AWS KMS key, orfalseto use a key managed by Amazon S3. Defaults tofalse.final -
kmsKeyArn
→ Input<
String?> ? -
ARN for KMS key used for Amazon S3 server side encryption. This value can only be set when
kmsEncryptedis true.final -
locationArn
→ Input<
String?> ? -
The ARN of the backed storage used for storing file data.
final
-
notificationPolicy
→ Input<
String?> ? -
The notification policy of the file share. For more information see the AWS Documentation. Default value is
{}.final -
objectAcl
→ Input<
String?> ? -
Access Control List permission for S3 objects. Defaults to
private.final -
oplocksEnabled
→ Input<
bool?> ? -
Boolean to indicate Opportunistic lock (oplock) status. Defaults to
true.final -
path
→ Input<
String?> ? -
File share path used by the NFS client to identify the mount point.
final
-
readOnly
→ Input<
bool?> ? -
Boolean to indicate write status of file share. File share does not accept writes if
true. Defaults tofalse.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
requesterPays
→ Input<
bool?> ? -
Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to
trueif you want the requester to pay instead of the bucket owner. Defaults tofalse.final -
roleArn
→ Input<
String?> ? -
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
smbAclEnabled
→ Input<
bool?> ? -
Set this value to
trueto enable ACL (access control list) on the SMB fileshare. Set it tofalseto map file and directory permissions to the POSIX permissions. This setting applies only toActiveDirectoryauthentication type.final -
Key-value map of resource tags. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
validUserLists
→ Input<
List< ?String> ?> -
A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if
authenticationis set toActiveDirectory.final -
vpcEndpointDnsName
→ Input<
String?> ? -
The DNS name of the VPC endpoint for S3 private link.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited