1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. storagegateway
  6. SmbFileShare

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
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:

    GatewayArn string
    The ARN of the S3 File Gateway that hosts the share.
    LocationArn 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.
    AccessBasedEnumeration bool
    Whether clients see only the files and folders they may access.
    AdminUserList List<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 Pulumi.AwsNative.StorageGateway.Inputs.SmbFileShareCacheAttributes
    CaseSensitivity Pulumi.AwsNative.StorageGateway.SmbFileShareCaseSensitivity
    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 Pulumi.AwsNative.StorageGateway.SmbFileShareEncryptionType
    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.
    GuessMimeTypeEnabled bool
    Whether the gateway infers the MIME type of uploaded objects from their extension.
    InvalidUserList List<string>
    Users and groups denied access to the SMB share.
    KmsEncrypted bool
    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.
    NotificationPolicy string
    The upload-notification settling period, as a JSON document.
    ObjectAcl Pulumi.AwsNative.StorageGateway.SmbFileShareObjectAcl
    The canned S3 ACL applied to objects the gateway writes.
    OplocksEnabled 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.
    ReadOnly bool
    Whether clients may write to the share.
    RequesterPays bool
    Whether the bucket is a Requester Pays bucket.
    SmbaclEnabled bool
    Whether the SMB share uses Windows ACLs rather than POSIX permissions.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags assigned to the file share.
    ValidUserList List<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.
    GatewayArn string
    The ARN of the S3 File Gateway that hosts the share.
    LocationArn 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.
    AccessBasedEnumeration bool
    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 SmbFileShareCacheAttributesArgs
    CaseSensitivity SmbFileShareCaseSensitivity
    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 SmbFileShareEncryptionType
    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.
    GuessMimeTypeEnabled bool
    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 bool
    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.
    NotificationPolicy string
    The upload-notification settling period, as a JSON document.
    ObjectAcl SmbFileShareObjectAcl
    The canned S3 ACL applied to objects the gateway writes.
    OplocksEnabled 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.
    ReadOnly bool
    Whether clients may write to the share.
    RequesterPays bool
    Whether the bucket is a Requester Pays bucket.
    SmbaclEnabled bool
    Whether the SMB share uses Windows ACLs rather than POSIX permissions.
    Tags TagArgs
    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.
    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_enumeration bool
    Whether clients see only the files and folders they may access.
    admin_user_list list(string)
    Users and groups granted administrative privileges on the SMB share.
    audit_destination_arn 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.
    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" | "CaseSensitive"
    Whether the SMB share is case sensitive or defers to the client.
    default_storage_class 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.
    encryption_type "SseS3" | "SseKms" | "DsseKms"
    The server-side encryption the gateway applies to objects it writes.
    file_share_name 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_type_enabled bool
    Whether the gateway infers the MIME type of uploaded objects from their extension.
    invalid_user_list list(string)
    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.
    tags list(object)
    Tags assigned to the file share.
    valid_user_list list(string)
    Users and groups permitted to access the SMB share.
    vpc_endpoint_dns_name string
    The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
    gatewayArn String
    The ARN of the S3 File Gateway that hosts the share.
    locationArn 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.
    accessBasedEnumeration Boolean
    Whether clients see only the files and folders they may access.
    adminUserList List<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 SmbFileShareCacheAttributes
    caseSensitivity SmbFileShareCaseSensitivity
    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 SmbFileShareEncryptionType
    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.
    guessMimeTypeEnabled Boolean
    Whether the gateway infers the MIME type of uploaded objects from their extension.
    invalidUserList List<String>
    Users and groups denied access to the SMB share.
    kmsEncrypted Boolean
    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.
    notificationPolicy String
    The upload-notification settling period, as a JSON document.
    objectAcl SmbFileShareObjectAcl
    The canned S3 ACL applied to objects the gateway writes.
    oplocksEnabled 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.
    readOnly Boolean
    Whether clients may write to the share.
    requesterPays Boolean
    Whether the bucket is a Requester Pays bucket.
    smbaclEnabled Boolean
    Whether the SMB share uses Windows ACLs rather than POSIX permissions.
    tags List<Tag>
    Tags assigned to the file share.
    validUserList List<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.
    gatewayArn string
    The ARN of the S3 File Gateway that hosts the share.
    locationArn 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.
    accessBasedEnumeration boolean
    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 SmbFileShareCacheAttributes
    caseSensitivity SmbFileShareCaseSensitivity
    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 SmbFileShareEncryptionType
    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.
    guessMimeTypeEnabled boolean
    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
    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.
    notificationPolicy string
    The upload-notification settling period, as a JSON document.
    objectAcl SmbFileShareObjectAcl
    The canned S3 ACL applied to objects the gateway writes.
    oplocksEnabled 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.
    readOnly boolean
    Whether clients may write to the share.
    requesterPays boolean
    Whether the bucket is a Requester Pays bucket.
    smbaclEnabled boolean
    Whether the SMB share uses Windows ACLs rather than POSIX permissions.
    tags Tag[]
    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.
    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_enumeration bool
    Whether clients see only the files and folders they may access.
    admin_user_list Sequence[str]
    Users and groups granted administrative privileges on the SMB share.
    audit_destination_arn str
    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 SmbFileShareCacheAttributesArgs
    case_sensitivity SmbFileShareCaseSensitivity
    Whether the SMB share is case sensitive or defers to the client.
    default_storage_class str
    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 SmbFileShareEncryptionType
    The server-side encryption the gateway applies to objects it writes.
    file_share_name 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_type_enabled bool
    Whether the gateway infers the MIME type of uploaded objects from their extension.
    invalid_user_list Sequence[str]
    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 SmbFileShareObjectAcl
    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.
    tags Sequence[TagArgs]
    Tags assigned to the file share.
    valid_user_list Sequence[str]
    Users and groups permitted to access the SMB share.
    vpc_endpoint_dns_name str
    The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
    gatewayArn String
    The ARN of the S3 File Gateway that hosts the share.
    locationArn 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.
    accessBasedEnumeration Boolean
    Whether clients see only the files and folders they may access.
    adminUserList List<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 Property Map
    caseSensitivity "ClientSpecified" | "CaseSensitive"
    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 "SseS3" | "SseKms" | "DsseKms"
    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.
    guessMimeTypeEnabled Boolean
    Whether the gateway infers the MIME type of uploaded objects from their extension.
    invalidUserList List<String>
    Users and groups denied access to the SMB share.
    kmsEncrypted Boolean
    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.
    notificationPolicy String
    The upload-notification settling period, as a JSON document.
    objectAcl "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.
    oplocksEnabled 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.
    readOnly Boolean
    Whether clients may write to the share.
    requesterPays Boolean
    Whether the bucket is a Requester Pays bucket.
    smbaclEnabled Boolean
    Whether the SMB share uses Windows ACLs rather than POSIX permissions.
    tags List<Property Map>
    Tags assigned to the file share.
    validUserList List<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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SmbFileShare resource produces the following output properties:

    FileShareArn string
    The ARN of the file share.
    FileShareId string
    The ID of the file share.
    FileShareStatus 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.
    FileShareArn string
    The ARN of the file share.
    FileShareId string
    The ID of the file share.
    FileShareStatus 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.
    file_share_arn string
    The ARN of the file share.
    file_share_id string
    The ID of the file share.
    file_share_status 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.
    fileShareArn String
    The ARN of the file share.
    fileShareId String
    The ID of the file share.
    fileShareStatus 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.
    fileShareArn string
    The ARN of the file share.
    fileShareId string
    The ID of the file share.
    fileShareStatus 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.
    file_share_arn str
    The ARN of the file share.
    file_share_id str
    The ID of the file share.
    file_share_status 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.
    fileShareArn String
    The ARN of the file share.
    fileShareId String
    The ID of the file share.
    fileShareStatus 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.
    CacheStaleTimeoutInSeconds int
    How long the directory contents cached by the gateway are considered valid.
    CacheStaleTimeoutInSeconds int
    How long the directory contents cached by the gateway are considered valid.
    cache_stale_timeout_in_seconds number
    How long the directory contents cached by the gateway are considered valid.
    cacheStaleTimeoutInSeconds Integer
    How long the directory contents cached by the gateway are considered valid.
    cacheStaleTimeoutInSeconds number
    How long the directory contents cached by the gateway are considered valid.
    cache_stale_timeout_in_seconds int
    How long the directory contents cached by the gateway are considered valid.
    cacheStaleTimeoutInSeconds Number
    How long the directory contents cached by the gateway are considered valid.

    SmbFileShareCaseSensitivity, SmbFileShareCaseSensitivityArgs

    ClientSpecified
    ClientSpecified
    CaseSensitive
    CaseSensitive
    SmbFileShareCaseSensitivityClientSpecified
    ClientSpecified
    SmbFileShareCaseSensitivityCaseSensitive
    CaseSensitive
    "ClientSpecified"
    ClientSpecified
    "CaseSensitive"
    CaseSensitive
    ClientSpecified
    ClientSpecified
    CaseSensitive
    CaseSensitive
    ClientSpecified
    ClientSpecified
    CaseSensitive
    CaseSensitive
    CLIENT_SPECIFIED
    ClientSpecified
    CASE_SENSITIVE
    CaseSensitive
    "ClientSpecified"
    ClientSpecified
    "CaseSensitive"
    CaseSensitive

    SmbFileShareEncryptionType, SmbFileShareEncryptionTypeArgs

    SseS3
    SseS3
    SseKms
    SseKms
    DsseKms
    DsseKms
    SmbFileShareEncryptionTypeSseS3
    SseS3
    SmbFileShareEncryptionTypeSseKms
    SseKms
    SmbFileShareEncryptionTypeDsseKms
    DsseKms
    "SseS3"
    SseS3
    "SseKms"
    SseKms
    "DsseKms"
    DsseKms
    SseS3
    SseS3
    SseKms
    SseKms
    DsseKms
    DsseKms
    SseS3
    SseS3
    SseKms
    SseKms
    DsseKms
    DsseKms
    SSE_S3
    SseS3
    SSE_KMS
    SseKms
    DSSE_KMS
    DsseKms
    "SseS3"
    SseS3
    "SseKms"
    SseKms
    "DsseKms"
    DsseKms

    SmbFileShareObjectAcl, SmbFileShareObjectAclArgs

    Private
    private
    PublicRead
    public-read
    PublicReadWrite
    public-read-write
    AuthenticatedRead
    authenticated-read
    BucketOwnerRead
    bucket-owner-read
    BucketOwnerFullControl
    bucket-owner-full-control
    AwsExecRead
    aws-exec-read
    SmbFileShareObjectAclPrivate
    private
    SmbFileShareObjectAclPublicRead
    public-read
    SmbFileShareObjectAclPublicReadWrite
    public-read-write
    SmbFileShareObjectAclAuthenticatedRead
    authenticated-read
    SmbFileShareObjectAclBucketOwnerRead
    bucket-owner-read
    SmbFileShareObjectAclBucketOwnerFullControl
    bucket-owner-full-control
    SmbFileShareObjectAclAwsExecRead
    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
    PublicRead
    public-read
    PublicReadWrite
    public-read-write
    AuthenticatedRead
    authenticated-read
    BucketOwnerRead
    bucket-owner-read
    BucketOwnerFullControl
    bucket-owner-full-control
    AwsExecRead
    aws-exec-read
    Private
    private
    PublicRead
    public-read
    PublicReadWrite
    public-read-write
    AuthenticatedRead
    authenticated-read
    BucketOwnerRead
    bucket-owner-read
    BucketOwnerFullControl
    bucket-owner-full-control
    AwsExecRead
    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.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.85.0
    published on Monday, Nov 2, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial