We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi
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.
Create SmbFileShare Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SmbFileShare(name: string, args: SmbFileShareArgs, opts?: CustomResourceOptions);@overload
def SmbFileShare(resource_name: str,
args: SmbFileShareArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SmbFileShare(resource_name: str,
opts: Optional[ResourceOptions] = None,
gateway_arn: Optional[str] = None,
role: Optional[str] = None,
location_arn: Optional[str] = None,
invalid_user_list: Optional[Sequence[str]] = None,
kms_key: Optional[str] = None,
cache_attributes: Optional[SmbFileShareCacheAttributesArgs] = None,
case_sensitivity: Optional[SmbFileShareCaseSensitivity] = None,
default_storage_class: Optional[str] = None,
encryption_type: Optional[SmbFileShareEncryptionType] = None,
file_share_name: Optional[str] = None,
authentication: Optional[str] = None,
guess_mime_type_enabled: Optional[bool] = None,
access_based_enumeration: Optional[bool] = None,
kms_encrypted: Optional[bool] = None,
bucket_region: Optional[str] = None,
audit_destination_arn: Optional[str] = None,
notification_policy: Optional[str] = None,
object_acl: Optional[SmbFileShareObjectAcl] = None,
oplocks_enabled: Optional[bool] = None,
read_only: Optional[bool] = None,
requester_pays: Optional[bool] = None,
admin_user_list: Optional[Sequence[str]] = None,
smbacl_enabled: Optional[bool] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
valid_user_list: Optional[Sequence[str]] = None,
vpc_endpoint_dns_name: Optional[str] = None)func NewSmbFileShare(ctx *Context, name string, args SmbFileShareArgs, opts ...ResourceOption) (*SmbFileShare, error)public SmbFileShare(string name, SmbFileShareArgs args, CustomResourceOptions? opts = null)
public SmbFileShare(String name, SmbFileShareArgs args)
public SmbFileShare(String name, SmbFileShareArgs args, CustomResourceOptions options)
type: aws-native:storagegateway:SmbFileShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_storagegateway_smb_file_share" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SmbFileShareArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SmbFileShareArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SmbFileShareArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SmbFileShareArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SmbFileShareArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SmbFileShare Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SmbFileShare resource accepts the following input properties:
- Gateway
Arn string - The ARN of the S3 File Gateway that hosts the share.
- Location
Arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- Role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- Access
Based boolEnumeration - Whether clients see only the files and folders they may access.
- Admin
User List<string>List - Users and groups granted administrative privileges on the SMB share.
- Audit
Destination stringArn - 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.
- Bucket
Region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- Cache
Attributes Pulumi.Aws Native. Storage Gateway. Inputs. Smb File Share Cache Attributes - Case
Sensitivity Pulumi.Aws Native. Storage Gateway. Smb File Share Case Sensitivity - Whether the SMB share is case sensitive or defers to the client.
- Default
Storage stringClass - 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.
- Encryption
Type Pulumi.Aws Native. Storage Gateway. Smb File Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- 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.
- Guess
Mime boolType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- Invalid
User List<string>List - Users and groups denied access to the SMB share.
- Kms
Encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- Kms
Key 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.
- Notification
Policy string - The upload-notification settling period, as a JSON document.
- Object
Acl Pulumi.Aws Native. Storage Gateway. Smb File Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- Oplocks
Enabled bool - 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.
- Read
Only bool - Whether clients may write to the share.
- Requester
Pays bool - Whether the bucket is a Requester Pays bucket.
- Smbacl
Enabled bool - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Tags assigned to the file share.
- Valid
User List<string>List - Users and groups permitted to access the SMB share.
- Vpc
Endpoint stringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- Gateway
Arn string - The ARN of the S3 File Gateway that hosts the share.
- Location
Arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- Role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- Access
Based boolEnumeration - Whether clients see only the files and folders they may access.
- Admin
User []stringList - Users and groups granted administrative privileges on the SMB share.
- Audit
Destination stringArn - 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.
- Bucket
Region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- Cache
Attributes SmbFile Share Cache Attributes Args - Case
Sensitivity SmbFile Share Case Sensitivity - Whether the SMB share is case sensitive or defers to the client.
- Default
Storage stringClass - 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.
- Encryption
Type SmbFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- 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.
- Guess
Mime boolType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- Invalid
User []stringList - Users and groups denied access to the SMB share.
- Kms
Encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- Kms
Key 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.
- Notification
Policy string - The upload-notification settling period, as a JSON document.
- Object
Acl SmbFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- Oplocks
Enabled bool - 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.
- Read
Only bool - Whether clients may write to the share.
- Requester
Pays bool - Whether the bucket is a Requester Pays bucket.
- Smbacl
Enabled bool - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
-
Tag
Args - Tags assigned to the file share.
- Valid
User []stringList - Users and groups permitted to access the SMB share.
- Vpc
Endpoint stringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway_
arn string - The ARN of the S3 File Gateway that hosts the share.
- location_
arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- access_
based_ boolenumeration - Whether clients see only the files and folders they may access.
- admin_
user_ list(string)list - Users and groups granted administrative privileges on the SMB share.
- audit_
destination_ stringarn - 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.
- bucket_
region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache_
attributes object - case_
sensitivity "ClientSpecified" | "Case Sensitive" - Whether the SMB share is case sensitive or defers to the client.
- default_
storage_ stringclass - 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.
- encryption_
type "SseS3" | "Sse Kms" | "Dsse Kms" - The server-side encryption the gateway applies to objects it writes.
- 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.
- guess_
mime_ booltype_ enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- invalid_
user_ list(string)list - Users and groups denied access to the SMB share.
- kms_
encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms_
key 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.
- notification_
policy string - The upload-notification settling period, as a JSON document.
- object_
acl "private" | "public-read" | "public-read-write" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "aws-exec-read" - The canned S3 ACL applied to objects the gateway writes.
- oplocks_
enabled bool - 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.
- read_
only bool - Whether clients may write to the share.
- requester_
pays bool - Whether the bucket is a Requester Pays bucket.
- smbacl_
enabled bool - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
- list(object)
- Tags assigned to the file share.
- valid_
user_ list(string)list - Users and groups permitted to access the SMB share.
- vpc_
endpoint_ stringdns_ name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway
Arn String - The ARN of the S3 File Gateway that hosts the share.
- location
Arn String - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role String
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- access
Based BooleanEnumeration - Whether clients see only the files and folders they may access.
- admin
User List<String>List - Users and groups granted administrative privileges on the SMB share.
- audit
Destination StringArn - 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.
- bucket
Region String - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache
Attributes SmbFile Share Cache Attributes - case
Sensitivity SmbFile Share Case Sensitivity - Whether the SMB share is case sensitive or defers to the client.
- default
Storage StringClass - 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.
- encryption
Type SmbFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- 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.
- guess
Mime BooleanType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- invalid
User List<String>List - Users and groups denied access to the SMB share.
- kms
Encrypted Boolean - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms
Key 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.
- notification
Policy String - The upload-notification settling period, as a JSON document.
- object
Acl SmbFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- oplocks
Enabled Boolean - 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.
- read
Only Boolean - Whether clients may write to the share.
- requester
Pays Boolean - Whether the bucket is a Requester Pays bucket.
- smbacl
Enabled Boolean - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
- List<Tag>
- Tags assigned to the file share.
- valid
User List<String>List - Users and groups permitted to access the SMB share.
- vpc
Endpoint StringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway
Arn string - The ARN of the S3 File Gateway that hosts the share.
- location
Arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- access
Based booleanEnumeration - Whether clients see only the files and folders they may access.
- admin
User string[]List - Users and groups granted administrative privileges on the SMB share.
- audit
Destination stringArn - 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.
- bucket
Region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache
Attributes SmbFile Share Cache Attributes - case
Sensitivity SmbFile Share Case Sensitivity - Whether the SMB share is case sensitive or defers to the client.
- default
Storage stringClass - 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.
- encryption
Type SmbFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- 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.
- guess
Mime booleanType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- invalid
User string[]List - Users and groups denied access to the SMB share.
- kms
Encrypted boolean - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms
Key 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.
- notification
Policy string - The upload-notification settling period, as a JSON document.
- object
Acl SmbFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- oplocks
Enabled boolean - 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.
- read
Only boolean - Whether clients may write to the share.
- requester
Pays boolean - Whether the bucket is a Requester Pays bucket.
- smbacl
Enabled boolean - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
- Tag[]
- Tags assigned to the file share.
- valid
User string[]List - Users and groups permitted to access the SMB share.
- vpc
Endpoint stringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway_
arn str - The ARN of the S3 File Gateway that hosts the share.
- location_
arn str - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role str
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- access_
based_ boolenumeration - Whether clients see only the files and folders they may access.
- admin_
user_ Sequence[str]list - Users and groups granted administrative privileges on the SMB share.
- audit_
destination_ strarn - 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 str
- 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.
- bucket_
region str - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache_
attributes SmbFile Share Cache Attributes Args - case_
sensitivity SmbFile Share Case Sensitivity - Whether the SMB share is case sensitive or defers to the client.
- default_
storage_ strclass - 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.
- encryption_
type SmbFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- str
- 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.
- guess_
mime_ booltype_ enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- invalid_
user_ Sequence[str]list - Users and groups denied access to the SMB share.
- kms_
encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms_
key str - 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.
- notification_
policy str - The upload-notification settling period, as a JSON document.
- object_
acl SmbFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- oplocks_
enabled bool - 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.
- read_
only bool - Whether clients may write to the share.
- requester_
pays bool - Whether the bucket is a Requester Pays bucket.
- smbacl_
enabled bool - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
-
Sequence[Tag
Args] - Tags assigned to the file share.
- valid_
user_ Sequence[str]list - Users and groups permitted to access the SMB share.
- vpc_
endpoint_ strdns_ name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway
Arn String - The ARN of the S3 File Gateway that hosts the share.
- location
Arn String - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role String
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- access
Based BooleanEnumeration - Whether clients see only the files and folders they may access.
- admin
User List<String>List - Users and groups granted administrative privileges on the SMB share.
- audit
Destination StringArn - 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.
- bucket
Region String - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache
Attributes Property Map - case
Sensitivity "ClientSpecified" | "Case Sensitive" - Whether the SMB share is case sensitive or defers to the client.
- default
Storage StringClass - 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.
- encryption
Type "SseS3" | "Sse Kms" | "Dsse Kms" - The server-side encryption the gateway applies to objects it writes.
- 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.
- guess
Mime BooleanType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- invalid
User List<String>List - Users and groups denied access to the SMB share.
- kms
Encrypted Boolean - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms
Key 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.
- notification
Policy String - The upload-notification settling period, as a JSON document.
- object
Acl "private" | "public-read" | "public-read-write" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "aws-exec-read" - The canned S3 ACL applied to objects the gateway writes.
- oplocks
Enabled Boolean - 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.
- read
Only Boolean - Whether clients may write to the share.
- requester
Pays Boolean - Whether the bucket is a Requester Pays bucket.
- smbacl
Enabled Boolean - Whether the SMB share uses Windows ACLs rather than POSIX permissions.
- List<Property Map>
- Tags assigned to the file share.
- valid
User List<String>List - Users and groups permitted to access the SMB share.
- vpc
Endpoint StringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
Outputs
All input properties are implicitly available as output properties. Additionally, the SmbFileShare resource produces the following output properties:
- string
- The ARN of the file share.
- string
- The ID of the file share.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Path string
- The export path the share is mounted or mapped at.
- string
- The ARN of the file share.
- string
- The ID of the file share.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Path string
- The export path the share is mounted or mapped at.
- string
- The ARN of the file share.
- string
- The ID of the file share.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- path string
- The export path the share is mounted or mapped at.
- String
- The ARN of the file share.
- String
- The ID of the file share.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- path String
- The export path the share is mounted or mapped at.
- string
- The ARN of the file share.
- string
- The ID of the file share.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- path string
- The export path the share is mounted or mapped at.
- str
- The ARN of the file share.
- str
- The ID of the file share.
- str
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- path str
- The export path the share is mounted or mapped at.
- String
- The ARN of the file share.
- String
- The ID of the file share.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- path String
- The export path the share is mounted or mapped at.
Supporting Types
SmbFileShareCacheAttributes, SmbFileShareCacheAttributesArgs
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.- Cache
Stale intTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- Cache
Stale intTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- cache_
stale_ numbertimeout_ in_ seconds - How long the directory contents cached by the gateway are considered valid.
- cache
Stale IntegerTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- cache
Stale numberTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- cache_
stale_ inttimeout_ in_ seconds - How long the directory contents cached by the gateway are considered valid.
- cache
Stale NumberTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
SmbFileShareCaseSensitivity, SmbFileShareCaseSensitivityArgs
- Client
Specified ClientSpecified- Case
Sensitive CaseSensitive
- Smb
File Share Case Sensitivity Client Specified ClientSpecified- Smb
File Share Case Sensitivity Case Sensitive CaseSensitive
- "Client
Specified" ClientSpecified- "Case
Sensitive" CaseSensitive
- Client
Specified ClientSpecified- Case
Sensitive CaseSensitive
- Client
Specified ClientSpecified- Case
Sensitive CaseSensitive
- CLIENT_SPECIFIED
ClientSpecified- CASE_SENSITIVE
CaseSensitive
- "Client
Specified" ClientSpecified- "Case
Sensitive" CaseSensitive
SmbFileShareEncryptionType, SmbFileShareEncryptionTypeArgs
- Sse
S3 SseS3- Sse
Kms SseKms- Dsse
Kms DsseKms
- Smb
File Share Encryption Type Sse S3 SseS3- Smb
File Share Encryption Type Sse Kms SseKms- Smb
File Share Encryption Type Dsse Kms DsseKms
- "Sse
S3" SseS3- "Sse
Kms" SseKms- "Dsse
Kms" DsseKms
- Sse
S3 SseS3- Sse
Kms SseKms- Dsse
Kms DsseKms
- Sse
S3 SseS3- Sse
Kms SseKms- Dsse
Kms DsseKms
- SSE_S3
SseS3- SSE_KMS
SseKms- DSSE_KMS
DsseKms
- "Sse
S3" SseS3- "Sse
Kms" SseKms- "Dsse
Kms" DsseKms
SmbFileShareObjectAcl, SmbFileShareObjectAclArgs
- Private
private- Public
Read public-read- Public
Read Write public-read-write- Authenticated
Read authenticated-read- Bucket
Owner Read bucket-owner-read- Bucket
Owner Full Control bucket-owner-full-control- Aws
Exec Read aws-exec-read
- Smb
File Share Object Acl Private private- Smb
File Share Object Acl Public Read public-read- Smb
File Share Object Acl Public Read Write public-read-write- Smb
File Share Object Acl Authenticated Read authenticated-read- Smb
File Share Object Acl Bucket Owner Read bucket-owner-read- Smb
File Share Object Acl Bucket Owner Full Control bucket-owner-full-control- Smb
File Share Object Acl Aws Exec Read aws-exec-read
- "private"
private- "public-read"
public-read- "public-read-write"
public-read-write- "authenticated-read"
authenticated-read- "bucket-owner-read"
bucket-owner-read- "bucket-owner-full-control"
bucket-owner-full-control- "aws-exec-read"
aws-exec-read
- Private
private- Public
Read public-read- Public
Read Write public-read-write- Authenticated
Read authenticated-read- Bucket
Owner Read bucket-owner-read- Bucket
Owner Full Control bucket-owner-full-control- Aws
Exec Read aws-exec-read
- Private
private- Public
Read public-read- Public
Read Write public-read-write- Authenticated
Read authenticated-read- Bucket
Owner Read bucket-owner-read- Bucket
Owner Full Control bucket-owner-full-control- Aws
Exec Read aws-exec-read
- PRIVATE
private- PUBLIC_READ
public-read- PUBLIC_READ_WRITE
public-read-write- AUTHENTICATED_READ
authenticated-read- BUCKET_OWNER_READ
bucket-owner-read- BUCKET_OWNER_FULL_CONTROL
bucket-owner-full-control- AWS_EXEC_READ
aws-exec-read
- "private"
private- "public-read"
public-read- "public-read-write"
public-read-write- "authenticated-read"
authenticated-read- "bucket-owner-read"
bucket-owner-read- "bucket-owner-full-control"
bucket-owner-full-control- "aws-exec-read"
aws-exec-read
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Nov 2, 2026 by Pulumi