SmbFileShareState constructor
- Input<
bool?> ? accessBasedEnumeration, - Input<
List< ? adminUserLists,String> ?> - Input<
String?> ? arn, - Input<
String?> ? auditDestinationArn, - Input<
String?> ? authentication, - Input<
String?> ? bucketRegion, - Input<
SmbFileShareCacheAttributes?> ? cacheAttributes, - Input<
String?> ? caseSensitivity, - Input<
String?> ? defaultStorageClass, - Input<
String?> ? gatewayArn, - Input<
bool?> ? guessMimeTypeEnabled, - Input<
List< ? invalidUserLists,String> ?> - Input<
bool?> ? kmsEncrypted, - Input<
String?> ? kmsKeyArn, - Input<
String?> ? locationArn, - Input<
String?> ? notificationPolicy, - Input<
String?> ? objectAcl, - Input<
bool?> ? oplocksEnabled, - Input<
String?> ? path, - Input<
bool?> ? readOnly, - Input<
String?> ? region, - Input<
bool?> ? requesterPays, - Input<
String?> ? roleArn, - Input<
bool?> ? smbAclEnabled, - Input<
Map< ? tags,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
List< ? validUserLists,String> ?> - Input<
String?> ? vpcEndpointDnsName,
Creates a new SmbFileShareState.
accessBasedEnumeration The files and folders on this share will only be visible to users with read access. Default value is false.
adminUserLists A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
arn ARN of the SMB File Share.
auditDestinationArn ARN of the CloudWatch Log Group used for the audit logs.
authentication The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
bucketRegion The region of the S3 buck used by the file share. Required when specifying a vpcEndpointDnsName.
cacheAttributes Refresh cache information. see cacheAttributes Block for more details.
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.
defaultStorageClass The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
fileShareName The name of the file share. Must be set if an S3 prefix name is set in locationArn.
fileshareId ID of the SMB File Share.
gatewayArn ARN of the file gateway.
guessMimeTypeEnabled Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
invalidUserLists A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
kmsEncrypted Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
kmsKeyArn ARN for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.
locationArn The ARN of the backed storage used for storing file data.
notificationPolicy The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
objectAcl Access Control List permission for S3 objects. Defaults to private.
oplocksEnabled Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
path File share path used by the NFS client to identify the mount point.
readOnly Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
requesterPays Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
roleArn The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
smbAclEnabled Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
tags Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
validUserLists 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 authentication is set to ActiveDirectory.
vpcEndpointDnsName The DNS name of the VPC endpoint for S3 private link.
Implementation
const SmbFileShareState({
this.accessBasedEnumeration,
this.adminUserLists,
this.arn,
this.auditDestinationArn,
this.authentication,
this.bucketRegion,
this.cacheAttributes,
this.caseSensitivity,
this.defaultStorageClass,
this.fileShareName,
this.fileshareId,
this.gatewayArn,
this.guessMimeTypeEnabled,
this.invalidUserLists,
this.kmsEncrypted,
this.kmsKeyArn,
this.locationArn,
this.notificationPolicy,
this.objectAcl,
this.oplocksEnabled,
this.path,
this.readOnly,
this.region,
this.requesterPays,
this.roleArn,
this.smbAclEnabled,
this.tags,
this.tagsAll,
this.validUserLists,
this.vpcEndpointDnsName,
});