# CfnSMBFileShare

Resource Type definition for AWS::StorageGateway::SMBFileShare.

An SMB file share exposes an Amazon S3 bucket through a Storage Gateway file gateway, so clients read and write objects as files over SMB. The share's variant is fixed by its resource type rather than by a property: the service constructs the two variants with different APIs, and a property carrying the choice would belong to neither API's input.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnSMBFileShare
Implements: IInspectable, ITaggableV2, IEnvironmentAware, ISMBFileShareRef, IConstruct, IDependable

- CloudFormation: [`AWS::StorageGateway::SMBFileShare`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-storagegateway-smbfileshare.html)
- 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 cfnSMBFileShare = new storagegateway.CfnSMBFileShare(this, 'MyCfnSMBFileShare', {
  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',
});
```

## Initializer

```ts
new CfnSMBFileShare(scope: Construct, id: string, props: CfnSMBFileShareProps)
```

## Construct Props

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

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

- `attrFileShareArn`: string — The ARN of the file share.

- `attrFileShareId`: string — The ID of the file share.

- `attrFileShareStatus`: string — The status of the file share.

  The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.

- `attrPath`: string — The export path the share is mounted or mapped at.

- `auditDestinationArn`: string — The ARN of the CloudWatch log group that receives the share's audit logs.

- `authentication`: string — The authentication the SMB share uses.

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

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

- `cdkTagManager`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `creationStack`: string[]

- `defaultStorageClass`: string — The S3 storage class for new objects.

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

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

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

- `gatewayArn`: string — 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;

- `kmsKey`: string — The KMS key used for encryption, when EncryptionType selects KMS.

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

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

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

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

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

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

- `role`: string — 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.

- `smbFileShareRef`: [SMBFileShareReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_storagegateway.SMBFileShareReference.html) — A reference to a SMBFileShare resource.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

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

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isCfnSMBFileShare(x: any): boolean` (static) — Checks whether the given object is a CfnSMBFileShare.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.