# CfnSMBFileShareProps

Properties for defining a `CfnSMBFileShare`.

Extends: CfnSMBFileShareProps
Used as props by: CfnSMBFileShare

- Source: Generated code
- Type last changed: v2.275.0 · 26 Oct 2026

## 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

- `accessBasedEnumeration`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether clients see only the files and folders they may access.

- `adminUserList`: string[] — Users and groups granted administrative privileges on the SMB share.

- `auditDestinationArn`: 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.

- `authentication`: 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.

- `bucketRegion`: string — The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.

- `cacheAttributes`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSMBFileShare.CacheAttributesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_storagegateway.CfnSMBFileShare.CacheAttributesProperty.html) — 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.

- `caseSensitivity`: string — Whether the SMB share is case sensitive or defers to the client.

- `defaultStorageClass`: 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.

- `encryptionType`: string — The server-side encryption the gateway applies to objects it writes.

- `fileShareName`: string — The name of the file share, which defaults to the bucket name when omitted.

  Removing this property from a template leaves the share's current value: the service documents no value that resets it.

- `gatewayArn`: string (required) — The ARN of the S3 File Gateway that hosts the share.

- `guessMimeTypeEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether the gateway infers the MIME type of uploaded objects from their extension.

- `invalidUserList`: string[] — Users and groups denied access to the SMB share.

- `kmsEncrypted`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Deprecated by the service in favour of EncryptionType;

  true selects KMS encryption. Retained because it remains readable and settable.

- `kmsKey`: 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.

- `locationArn`: string (required) — The ARN of the S3 bucket, or bucket prefix, the share exposes.

- `notificationPolicy`: string — The upload-notification settling period, as a JSON document.

- `objectAcl`: string — The canned S3 ACL applied to objects the gateway writes.

- `oplocksEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether the SMB share grants opportunistic locks.

  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.

- `readOnly`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether clients may write to the share.

- `requesterPays`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether the bucket is a Requester Pays bucket.

- `role`: string (required) — The ARN of the IAM role the gateway assumes when it accesses the S3 location.

- `smbaclEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Whether the SMB share uses Windows ACLs rather than POSIX permissions.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Tags assigned to the file share.

- `validUserList`: string[] — Users and groups permitted to access the SMB share.

- `vpcEndpointDnsName`: string — The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.