CfnSMBFileShareProps Struct Added in v2.275.0
Properties for defining a CfnSMBFileShare.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_storagegateway as storagegateway } from 'aws-cdk-lib';
const cfnSMBFileShareProps: storagegateway.CfnSMBFileShareProps = {
gatewayArn: 'gatewayArn',
locationArn: 'locationArn',
role: 'role',
// the properties below are optional
accessBasedEnumeration: false,
adminUserList: ['adminUserList'],
auditDestinationArn: 'auditDestinationArn',
authentication: 'authentication',
bucketRegion: 'bucketRegion',
cacheAttributes: {
cacheStaleTimeoutInSeconds: 123,
},
caseSensitivity: 'caseSensitivity',
defaultStorageClass: 'defaultStorageClass',
encryptionType: 'encryptionType',
fileShareName: 'fileShareName',
guessMimeTypeEnabled: false,
invalidUserList: ['invalidUserList'],
kmsEncrypted: false,
kmsKey: 'kmsKey',
notificationPolicy: 'notificationPolicy',
objectAcl: 'objectAcl',
oplocksEnabled: false,
readOnly: false,
requesterPays: false,
smbaclEnabled: false,
tags: [{
key: 'key',
value: 'value',
}],
validUserList: ['validUserList'],
vpcEndpointDnsName: 'vpcEndpointDnsName',
};
Properties
accessBasedEnumerationoptionalboolean | IResolvableaccess_based_enumerationoptionaltyping.Union[bool, IResolvable]accessBasedEnumerationoptionalBooleanAccessBasedEnumerationoptionalboolAccessBasedEnumerationoptionalinterface{}#Whether clients see only the files and folders they may access.
adminUserListoptionalstring[]admin_user_listoptionaltyping.List[str]adminUserListoptionalList<String>AdminUserListoptionalstring[]AdminUserListoptional*[]*string#Users and groups granted administrative privileges on the SMB share.
auditDestinationArnoptionalstringaudit_destination_arnoptionalstrauditDestinationArnoptionalStringAuditDestinationArnoptionalstringAuditDestinationArnoptional*string#The ARN of the CloudWatch log group that receives the share's audit logs.
Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
authenticationoptionalstringauthenticationoptionalstrauthenticationoptionalStringAuthenticationoptionalstringAuthenticationoptional*string#The authentication the SMB share uses.
The service accepts ActiveDirectory and GuestAccess; it is a length-bounded string in the API model rather than an enumeration.
bucketRegionoptionalstringbucket_regionoptionalstrbucketRegionoptionalStringBucketRegionoptionalstringBucketRegionoptional*string#The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
cacheAttributesoptionalIResolvable | CfnSMBFileShare.CacheAttributesPropertycache_attributesoptionaltyping.Union[IResolvable, CacheAttributesProperty]cacheAttributesoptionalIResolvableCacheAttributesoptionalIResolvableCacheAttributesoptionalinterface{}#Refresh cache information for the file share.
Removing this property from a template leaves the share's current value: the service documents no value that resets it.
caseSensitivityoptionalstringcase_sensitivityoptionalstrcaseSensitivityoptionalStringCaseSensitivityoptionalstringCaseSensitivityoptional*string#Whether the SMB share is case sensitive or defers to the client.
defaultStorageClassoptionalstringdefault_storage_classoptionalstrdefaultStorageClassoptionalStringDefaultStorageClassoptionalstringDefaultStorageClassoptional*string#The S3 storage class for new objects.
The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
encryptionTypeoptionalstringencryption_typeoptionalstrencryptionTypeoptionalStringEncryptionTypeoptionalstringEncryptionTypeoptional*string#The server-side encryption the gateway applies to objects it writes.
The ARN of the S3 File Gateway that hosts the share.
guessMimeTypeEnabledoptionalboolean | IResolvableguess_mime_type_enabledoptionaltyping.Union[bool, IResolvable]guessMimeTypeEnabledoptionalBooleanGuessMimeTypeEnabledoptionalboolGuessMimeTypeEnabledoptionalinterface{}#Whether the gateway infers the MIME type of uploaded objects from their extension.
invalidUserListoptionalstring[]invalid_user_listoptionaltyping.List[str]invalidUserListoptionalList<String>InvalidUserListoptionalstring[]InvalidUserListoptional*[]*string#Users and groups denied access to the SMB share.
kmsEncryptedoptionalboolean | IResolvablekms_encryptedoptionaltyping.Union[bool, IResolvable]kmsEncryptedoptionalBooleanKmsEncryptedoptionalboolKmsEncryptedoptionalinterface{}#Deprecated by the service in favour of EncryptionType;
true selects KMS encryption. Retained because it remains readable and settable.
kmsKeyoptionalstringkms_keyoptionalstrkmsKeyoptionalStringKmsKeyoptionalstringKmsKeyoptional*string#The KMS key used for encryption, when EncryptionType selects KMS.
Removing this property from a template leaves the share's current value: the service documents no value that resets it.
The ARN of the S3 bucket, or bucket prefix, the share exposes.
notificationPolicyoptionalstringnotification_policyoptionalstrnotificationPolicyoptionalStringNotificationPolicyoptionalstringNotificationPolicyoptional*string#The upload-notification settling period, as a JSON document.
objectAcloptionalstringobject_acloptionalstrobjectAcloptionalStringObjectAcloptionalstringObjectAcloptional*string#The canned S3 ACL applied to objects the gateway writes.
oplocksEnabledoptionalboolean | IResolvableoplocks_enabledoptionaltyping.Union[bool, IResolvable]oplocksEnabledoptionalBooleanOplocksEnabledoptionalboolOplocksEnabledoptionalinterface{}#Whether the SMB share grants opportunistic locks.
notes
Removing this property from a template leaves the live value unchanged rather than restoring the created default, because that default depends on the gateway's software version -- opportunistic locking is enabled by default only on appliances at 1.19.0.0 or above -- and the version is not part of this resource. Set the value explicitly rather than relying on removal.
readOnlyoptionalboolean | IResolvableread_onlyoptionaltyping.Union[bool, IResolvable]readOnlyoptionalBooleanReadOnlyoptionalboolReadOnlyoptionalinterface{}#Whether clients may write to the share.
requesterPaysoptionalboolean | IResolvablerequester_paysoptionaltyping.Union[bool, IResolvable]requesterPaysoptionalBooleanRequesterPaysoptionalboolRequesterPaysoptionalinterface{}#Whether the bucket is a Requester Pays bucket.
The ARN of the IAM role the gateway assumes when it accesses the S3 location.
smbaclEnabledoptionalboolean | IResolvablesmbacl_enabledoptionaltyping.Union[bool, IResolvable]smbaclEnabledoptionalBooleanSmbaclEnabledoptionalboolSmbaclEnabledoptionalinterface{}#Whether the SMB share uses Windows ACLs rather than POSIX permissions.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Tags assigned to the file share.
validUserListoptionalstring[]valid_user_listoptionaltyping.List[str]validUserListoptionalList<String>ValidUserListoptionalstring[]ValidUserListoptional*[]*string#Users and groups permitted to access the SMB share.
vpcEndpointDnsNameoptionalstringvpc_endpoint_dns_nameoptionalstrvpcEndpointDnsNameoptionalStringVpcEndpointDnsNameoptionalstringVpcEndpointDnsNameoptional*string#The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.