Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. storagegateway
  5. SmbFileShare
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.storagegateway.SmbFileShare

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    Manages an AWS Storage Gateway SMB File Share.

    Example Usage

    Active Directory Authentication

    NOTE: The gateway must have already joined the Active Directory domain prior to SMB file share creationE.g., via “SMB Settings” in the AWS Storage Gateway console or smb_active_directory_settings in the aws.storagegateway.Gateway resource.

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "ActiveDirectory",
    gatewayArn: exampleAwsStoragegatewayGateway.arn,
    locationArn: exampleAwsS3Bucket.arn,
    roleArn: exampleAwsIamRole.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.storagegateway.SmbFileShare("example",
    authentication="ActiveDirectory",
    gateway_arn=example_aws_storagegateway_gateway["arn"],
    location_arn=example_aws_s3_bucket["arn"],
    role_arn=example_aws_iam_role["arn"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewSmbFileShare(ctx, "example", &storagegateway.SmbFileShareArgs{
			Authentication: pulumi.String("ActiveDirectory"),
			GatewayArn:     pulumi.Any(exampleAwsStoragegatewayGateway.Arn),
			LocationArn:    pulumi.Any(exampleAwsS3Bucket.Arn),
			RoleArn:        pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.SmbFileShare("example", new()
    {
        Authentication = "ActiveDirectory",
        GatewayArn = exampleAwsStoragegatewayGateway.Arn,
        LocationArn = exampleAwsS3Bucket.Arn,
        RoleArn = exampleAwsIamRole.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.SmbFileShare;
import com.pulumi.aws.storagegateway.SmbFileShareArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new SmbFileShare("example", SmbFileShareArgs.builder()
            .authentication("ActiveDirectory")
            .gatewayArn(exampleAwsStoragegatewayGateway.arn())
            .locationArn(exampleAwsS3Bucket.arn())
            .roleArn(exampleAwsIamRole.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:storagegateway:SmbFileShare
    properties:
      authentication: ActiveDirectory
      gatewayArn: ${exampleAwsStoragegatewayGateway.arn}
      locationArn: ${exampleAwsS3Bucket.arn}
      roleArn: ${exampleAwsIamRole.arn}

    Guest Authentication

    NOTE: The gateway must have already had the SMB guest password set prior to SMB file share creationE.g., via “SMB Settings” in the AWS Storage Gateway console or smb_guest_password in the aws.storagegateway.Gateway resource.

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "GuestAccess",
    gatewayArn: exampleAwsStoragegatewayGateway.arn,
    locationArn: exampleAwsS3Bucket.arn,
    roleArn: exampleAwsIamRole.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.storagegateway.SmbFileShare("example",
    authentication="GuestAccess",
    gateway_arn=example_aws_storagegateway_gateway["arn"],
    location_arn=example_aws_s3_bucket["arn"],
    role_arn=example_aws_iam_role["arn"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewSmbFileShare(ctx, "example", &storagegateway.SmbFileShareArgs{
			Authentication: pulumi.String("GuestAccess"),
			GatewayArn:     pulumi.Any(exampleAwsStoragegatewayGateway.Arn),
			LocationArn:    pulumi.Any(exampleAwsS3Bucket.Arn),
			RoleArn:        pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.StorageGateway.SmbFileShare("example", new()
    {
        Authentication = "GuestAccess",
        GatewayArn = exampleAwsStoragegatewayGateway.Arn,
        LocationArn = exampleAwsS3Bucket.Arn,
        RoleArn = exampleAwsIamRole.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.SmbFileShare;
import com.pulumi.aws.storagegateway.SmbFileShareArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new SmbFileShare("example", SmbFileShareArgs.builder()
            .authentication("GuestAccess")
            .gatewayArn(exampleAwsStoragegatewayGateway.arn())
            .locationArn(exampleAwsS3Bucket.arn())
            .roleArn(exampleAwsIamRole.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:storagegateway:SmbFileShare
    properties:
      authentication: GuestAccess
      gatewayArn: ${exampleAwsStoragegatewayGateway.arn}
      locationArn: ${exampleAwsS3Bucket.arn}
      roleArn: ${exampleAwsIamRole.arn}

    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_arn: Optional[str] = None,
                 location_arn: Optional[str] = None,
                 kms_encrypted: Optional[bool] = None,
                 audit_destination_arn: Optional[str] = None,
                 cache_attributes: Optional[SmbFileShareCacheAttributesArgs] = None,
                 case_sensitivity: Optional[str] = None,
                 default_storage_class: Optional[str] = None,
                 file_share_name: Optional[str] = None,
                 authentication: Optional[str] = None,
                 guess_mime_type_enabled: Optional[bool] = None,
                 invalid_user_lists: Optional[Sequence[str]] = None,
                 access_based_enumeration: Optional[bool] = None,
                 kms_key_arn: Optional[str] = None,
                 bucket_region: Optional[str] = None,
                 notification_policy: Optional[str] = None,
                 object_acl: Optional[str] = None,
                 oplocks_enabled: Optional[bool] = None,
                 read_only: Optional[bool] = None,
                 requester_pays: Optional[bool] = None,
                 admin_user_lists: Optional[Sequence[str]] = None,
                 smb_acl_enabled: Optional[bool] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 valid_user_lists: 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:storagegateway:SmbFileShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var smbFileShareResource = new Aws.StorageGateway.SmbFileShare("smbFileShareResource", new()
{
    GatewayArn = "string",
    RoleArn = "string",
    LocationArn = "string",
    KmsEncrypted = false,
    AuditDestinationArn = "string",
    CacheAttributes = new Aws.StorageGateway.Inputs.SmbFileShareCacheAttributesArgs
    {
        CacheStaleTimeoutInSeconds = 0,
    },
    CaseSensitivity = "string",
    DefaultStorageClass = "string",
    FileShareName = "string",
    Authentication = "string",
    GuessMimeTypeEnabled = false,
    InvalidUserLists = new[]
    {
        "string",
    },
    AccessBasedEnumeration = false,
    KmsKeyArn = "string",
    BucketRegion = "string",
    NotificationPolicy = "string",
    ObjectAcl = "string",
    OplocksEnabled = false,
    ReadOnly = false,
    RequesterPays = false,
    AdminUserLists = new[]
    {
        "string",
    },
    SmbAclEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    ValidUserLists = new[]
    {
        "string",
    },
    VpcEndpointDnsName = "string",
});

    example, err := storagegateway.NewSmbFileShare(ctx, "smbFileShareResource", &storagegateway.SmbFileShareArgs{
	GatewayArn:          pulumi.String("string"),
	RoleArn:             pulumi.String("string"),
	LocationArn:         pulumi.String("string"),
	KmsEncrypted:        pulumi.Bool(false),
	AuditDestinationArn: pulumi.String("string"),
	CacheAttributes: &storagegateway.SmbFileShareCacheAttributesArgs{
		CacheStaleTimeoutInSeconds: pulumi.Int(0),
	},
	CaseSensitivity:      pulumi.String("string"),
	DefaultStorageClass:  pulumi.String("string"),
	FileShareName:        pulumi.String("string"),
	Authentication:       pulumi.String("string"),
	GuessMimeTypeEnabled: pulumi.Bool(false),
	InvalidUserLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	AccessBasedEnumeration: pulumi.Bool(false),
	KmsKeyArn:              pulumi.String("string"),
	BucketRegion:           pulumi.String("string"),
	NotificationPolicy:     pulumi.String("string"),
	ObjectAcl:              pulumi.String("string"),
	OplocksEnabled:         pulumi.Bool(false),
	ReadOnly:               pulumi.Bool(false),
	RequesterPays:          pulumi.Bool(false),
	AdminUserLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	SmbAclEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ValidUserLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcEndpointDnsName: pulumi.String("string"),
})

    var smbFileShareResource = new SmbFileShare("smbFileShareResource", SmbFileShareArgs.builder()
    .gatewayArn("string")
    .roleArn("string")
    .locationArn("string")
    .kmsEncrypted(false)
    .auditDestinationArn("string")
    .cacheAttributes(SmbFileShareCacheAttributesArgs.builder()
        .cacheStaleTimeoutInSeconds(0)
        .build())
    .caseSensitivity("string")
    .defaultStorageClass("string")
    .fileShareName("string")
    .authentication("string")
    .guessMimeTypeEnabled(false)
    .invalidUserLists("string")
    .accessBasedEnumeration(false)
    .kmsKeyArn("string")
    .bucketRegion("string")
    .notificationPolicy("string")
    .objectAcl("string")
    .oplocksEnabled(false)
    .readOnly(false)
    .requesterPays(false)
    .adminUserLists("string")
    .smbAclEnabled(false)
    .tags(Map.of("string", "string"))
    .validUserLists("string")
    .vpcEndpointDnsName("string")
    .build());

    smb_file_share_resource = aws.storagegateway.SmbFileShare("smbFileShareResource",
    gateway_arn="string",
    role_arn="string",
    location_arn="string",
    kms_encrypted=False,
    audit_destination_arn="string",
    cache_attributes={
        "cache_stale_timeout_in_seconds": 0,
    },
    case_sensitivity="string",
    default_storage_class="string",
    file_share_name="string",
    authentication="string",
    guess_mime_type_enabled=False,
    invalid_user_lists=["string"],
    access_based_enumeration=False,
    kms_key_arn="string",
    bucket_region="string",
    notification_policy="string",
    object_acl="string",
    oplocks_enabled=False,
    read_only=False,
    requester_pays=False,
    admin_user_lists=["string"],
    smb_acl_enabled=False,
    tags={
        "string": "string",
    },
    valid_user_lists=["string"],
    vpc_endpoint_dns_name="string")

    const smbFileShareResource = new aws.storagegateway.SmbFileShare("smbFileShareResource", {
    gatewayArn: "string",
    roleArn: "string",
    locationArn: "string",
    kmsEncrypted: false,
    auditDestinationArn: "string",
    cacheAttributes: {
        cacheStaleTimeoutInSeconds: 0,
    },
    caseSensitivity: "string",
    defaultStorageClass: "string",
    fileShareName: "string",
    authentication: "string",
    guessMimeTypeEnabled: false,
    invalidUserLists: ["string"],
    accessBasedEnumeration: false,
    kmsKeyArn: "string",
    bucketRegion: "string",
    notificationPolicy: "string",
    objectAcl: "string",
    oplocksEnabled: false,
    readOnly: false,
    requesterPays: false,
    adminUserLists: ["string"],
    smbAclEnabled: false,
    tags: {
        string: "string",
    },
    validUserLists: ["string"],
    vpcEndpointDnsName: "string",
});

    type: aws:storagegateway:SmbFileShare
properties:
    accessBasedEnumeration: false
    adminUserLists:
        - string
    auditDestinationArn: string
    authentication: string
    bucketRegion: string
    cacheAttributes:
        cacheStaleTimeoutInSeconds: 0
    caseSensitivity: string
    defaultStorageClass: string
    fileShareName: string
    gatewayArn: string
    guessMimeTypeEnabled: false
    invalidUserLists:
        - string
    kmsEncrypted: false
    kmsKeyArn: string
    locationArn: string
    notificationPolicy: string
    objectAcl: string
    oplocksEnabled: false
    readOnly: false
    requesterPays: false
    roleArn: string
    smbAclEnabled: false
    tags:
        string: string
    validUserLists:
        - string
    vpcEndpointDnsName: string

    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
    Amazon Resource Name (ARN) of the file gateway.
    LocationArn string
    The ARN of the backed storage used for storing file data.
    RoleArn string
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    AccessBasedEnumeration bool
    The files and folders on this share will only be visible to users with read access. Default value is false.
    AdminUserLists List<string>
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    Authentication string
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    BucketRegion string
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    CacheAttributes SmbFileShareCacheAttributes

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    CaseSensitivity string
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    DefaultStorageClass string
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    FileShareName string
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    GuessMimeTypeEnabled bool
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    InvalidUserLists List<string>
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    KmsEncrypted bool
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    KmsKeyArn string
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    NotificationPolicy string
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    ObjectAcl string
    Access Control List permission for S3 objects. Defaults to private.
    OplocksEnabled bool
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    ReadOnly bool
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    RequesterPays bool
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    SmbAclEnabled bool
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ValidUserLists List<string>
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    VpcEndpointDnsName string
    The DNS name of the VPC endpoint for S3 private link.
    GatewayArn string
    Amazon Resource Name (ARN) of the file gateway.
    LocationArn string
    The ARN of the backed storage used for storing file data.
    RoleArn string
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    AccessBasedEnumeration bool
    The files and folders on this share will only be visible to users with read access. Default value is false.
    AdminUserLists []string
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    Authentication string
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    BucketRegion string
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    CacheAttributes SmbFileShareCacheAttributesArgs

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    CaseSensitivity string
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    DefaultStorageClass string
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    FileShareName string
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    GuessMimeTypeEnabled bool
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    InvalidUserLists []string
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    KmsEncrypted bool
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    KmsKeyArn string
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    NotificationPolicy string
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    ObjectAcl string
    Access Control List permission for S3 objects. Defaults to private.
    OplocksEnabled bool
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    ReadOnly bool
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    RequesterPays bool
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    SmbAclEnabled bool
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ValidUserLists []string
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    VpcEndpointDnsName string
    The DNS name of the VPC endpoint for S3 private link.
    gatewayArn String
    Amazon Resource Name (ARN) of the file gateway.
    locationArn String
    The ARN of the backed storage used for storing file data.
    roleArn String
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    accessBasedEnumeration Boolean
    The files and folders on this share will only be visible to users with read access. Default value is false.
    adminUserLists List<String>
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication String
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucketRegion String
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cacheAttributes SmbFileShareCacheAttributes

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    caseSensitivity String
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    defaultStorageClass String
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    fileShareName String
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    guessMimeTypeEnabled Boolean
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalidUserLists List<String>
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kmsEncrypted Boolean
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kmsKeyArn String
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    notificationPolicy String
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    objectAcl String
    Access Control List permission for S3 objects. Defaults to private.
    oplocksEnabled Boolean
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    readOnly Boolean
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requesterPays Boolean
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    smbAclEnabled Boolean
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    validUserLists List<String>
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpcEndpointDnsName String
    The DNS name of the VPC endpoint for S3 private link.
    gatewayArn string
    Amazon Resource Name (ARN) of the file gateway.
    locationArn string
    The ARN of the backed storage used for storing file data.
    roleArn string
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    accessBasedEnumeration boolean
    The files and folders on this share will only be visible to users with read access. Default value is false.
    adminUserLists string[]
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    auditDestinationArn string
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication string
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucketRegion string
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cacheAttributes SmbFileShareCacheAttributes

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    caseSensitivity string
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    defaultStorageClass string
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    fileShareName string
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    guessMimeTypeEnabled boolean
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalidUserLists string[]
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kmsEncrypted boolean
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kmsKeyArn string
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    notificationPolicy string
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    objectAcl string
    Access Control List permission for S3 objects. Defaults to private.
    oplocksEnabled boolean
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    readOnly boolean
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requesterPays boolean
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    smbAclEnabled boolean
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    validUserLists string[]
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpcEndpointDnsName string
    The DNS name of the VPC endpoint for S3 private link.
    gateway_arn str
    Amazon Resource Name (ARN) of the file gateway.
    location_arn str
    The ARN of the backed storage used for storing file data.
    role_arn str
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    access_based_enumeration bool
    The files and folders on this share will only be visible to users with read access. Default value is false.
    admin_user_lists Sequence[str]
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    audit_destination_arn str
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication str
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucket_region str
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cache_attributes SmbFileShareCacheAttributesArgs

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    case_sensitivity str
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    default_storage_class str
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    file_share_name str
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    guess_mime_type_enabled bool
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalid_user_lists Sequence[str]
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kms_encrypted bool
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kms_key_arn str
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    notification_policy str
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    object_acl str
    Access Control List permission for S3 objects. Defaults to private.
    oplocks_enabled bool
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    read_only bool
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requester_pays bool
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    smb_acl_enabled bool
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    valid_user_lists Sequence[str]
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpc_endpoint_dns_name str
    The DNS name of the VPC endpoint for S3 private link.
    gatewayArn String
    Amazon Resource Name (ARN) of the file gateway.
    locationArn String
    The ARN of the backed storage used for storing file data.
    roleArn String
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    accessBasedEnumeration Boolean
    The files and folders on this share will only be visible to users with read access. Default value is false.
    adminUserLists List<String>
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication String
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucketRegion String
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cacheAttributes Property Map

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    caseSensitivity String
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    defaultStorageClass String
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    fileShareName String
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    guessMimeTypeEnabled Boolean
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalidUserLists List<String>
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kmsEncrypted Boolean
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kmsKeyArn String
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    notificationPolicy String
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    objectAcl String
    Access Control List permission for S3 objects. Defaults to private.
    oplocksEnabled Boolean
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    readOnly Boolean
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requesterPays Boolean
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    smbAclEnabled Boolean
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    validUserLists List<String>
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpcEndpointDnsName String
    The DNS name of the VPC endpoint for S3 private link.

    Outputs

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

    Arn string
    Amazon Resource Name (ARN) of the SMB File Share.
    FileshareId string
    ID of the SMB File Share.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    File share path used by the NFS client to identify the mount point.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the SMB File Share.
    FileshareId string
    ID of the SMB File Share.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    File share path used by the NFS client to identify the mount point.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the SMB File Share.
    fileshareId String
    ID of the SMB File Share.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    File share path used by the NFS client to identify the mount point.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the SMB File Share.
    fileshareId string
    ID of the SMB File Share.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    File share path used by the NFS client to identify the mount point.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the SMB File Share.
    fileshare_id str
    ID of the SMB File Share.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    File share path used by the NFS client to identify the mount point.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the SMB File Share.
    fileshareId String
    ID of the SMB File Share.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    File share path used by the NFS client to identify the mount point.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing SmbFileShare Resource

    Get an existing SmbFileShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SmbFileShareState, opts?: CustomResourceOptions): SmbFileShare
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_based_enumeration: Optional[bool] = None,
        admin_user_lists: Optional[Sequence[str]] = None,
        arn: Optional[str] = None,
        audit_destination_arn: Optional[str] = None,
        authentication: Optional[str] = None,
        bucket_region: Optional[str] = None,
        cache_attributes: Optional[SmbFileShareCacheAttributesArgs] = None,
        case_sensitivity: Optional[str] = None,
        default_storage_class: Optional[str] = None,
        file_share_name: Optional[str] = None,
        fileshare_id: Optional[str] = None,
        gateway_arn: Optional[str] = None,
        guess_mime_type_enabled: Optional[bool] = None,
        invalid_user_lists: Optional[Sequence[str]] = None,
        kms_encrypted: Optional[bool] = None,
        kms_key_arn: Optional[str] = None,
        location_arn: Optional[str] = None,
        notification_policy: Optional[str] = None,
        object_acl: Optional[str] = None,
        oplocks_enabled: Optional[bool] = None,
        path: Optional[str] = None,
        read_only: Optional[bool] = None,
        requester_pays: Optional[bool] = None,
        role_arn: Optional[str] = None,
        smb_acl_enabled: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        valid_user_lists: Optional[Sequence[str]] = None,
        vpc_endpoint_dns_name: Optional[str] = None) -> SmbFileShare
    func GetSmbFileShare(ctx *Context, name string, id IDInput, state *SmbFileShareState, opts ...ResourceOption) (*SmbFileShare, error)
    public static SmbFileShare Get(string name, Input<string> id, SmbFileShareState? state, CustomResourceOptions? opts = null)
    public static SmbFileShare get(String name, Output<String> id, SmbFileShareState state, CustomResourceOptions options)
    resources:  _:    type: aws:storagegateway:SmbFileShare    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessBasedEnumeration bool
    The files and folders on this share will only be visible to users with read access. Default value is false.
    AdminUserLists List<string>
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    Arn string
    Amazon Resource Name (ARN) of the SMB File Share.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    Authentication string
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    BucketRegion string
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    CacheAttributes SmbFileShareCacheAttributes

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    CaseSensitivity string
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    DefaultStorageClass string
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    FileShareName string
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    FileshareId string
    ID of the SMB File Share.
    GatewayArn string
    Amazon Resource Name (ARN) of the file gateway.
    GuessMimeTypeEnabled bool
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    InvalidUserLists List<string>
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    KmsEncrypted bool
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    KmsKeyArn string
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    LocationArn string
    The ARN of the backed storage used for storing file data.
    NotificationPolicy string
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    ObjectAcl string
    Access Control List permission for S3 objects. Defaults to private.
    OplocksEnabled bool
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    Path string
    File share path used by the NFS client to identify the mount point.
    ReadOnly bool
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    RequesterPays bool
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    RoleArn string
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    SmbAclEnabled bool
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ValidUserLists List<string>
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    VpcEndpointDnsName string
    The DNS name of the VPC endpoint for S3 private link.
    AccessBasedEnumeration bool
    The files and folders on this share will only be visible to users with read access. Default value is false.
    AdminUserLists []string
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    Arn string
    Amazon Resource Name (ARN) of the SMB File Share.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    Authentication string
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    BucketRegion string
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    CacheAttributes SmbFileShareCacheAttributesArgs

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    CaseSensitivity string
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    DefaultStorageClass string
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    FileShareName string
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    FileshareId string
    ID of the SMB File Share.
    GatewayArn string
    Amazon Resource Name (ARN) of the file gateway.
    GuessMimeTypeEnabled bool
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    InvalidUserLists []string
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    KmsEncrypted bool
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    KmsKeyArn string
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    LocationArn string
    The ARN of the backed storage used for storing file data.
    NotificationPolicy string
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    ObjectAcl string
    Access Control List permission for S3 objects. Defaults to private.
    OplocksEnabled bool
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    Path string
    File share path used by the NFS client to identify the mount point.
    ReadOnly bool
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    RequesterPays bool
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    RoleArn string
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    SmbAclEnabled bool
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    ValidUserLists []string
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    VpcEndpointDnsName string
    The DNS name of the VPC endpoint for S3 private link.
    accessBasedEnumeration Boolean
    The files and folders on this share will only be visible to users with read access. Default value is false.
    adminUserLists List<String>
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    arn String
    Amazon Resource Name (ARN) of the SMB File Share.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication String
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucketRegion String
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cacheAttributes SmbFileShareCacheAttributes

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    caseSensitivity String
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    defaultStorageClass String
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    fileShareName String
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    fileshareId String
    ID of the SMB File Share.
    gatewayArn String
    Amazon Resource Name (ARN) of the file gateway.
    guessMimeTypeEnabled Boolean
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalidUserLists List<String>
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kmsEncrypted Boolean
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kmsKeyArn String
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    locationArn String
    The ARN of the backed storage used for storing file data.
    notificationPolicy String
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    objectAcl String
    Access Control List permission for S3 objects. Defaults to private.
    oplocksEnabled Boolean
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    path String
    File share path used by the NFS client to identify the mount point.
    readOnly Boolean
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requesterPays Boolean
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    roleArn String
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    smbAclEnabled Boolean
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    validUserLists List<String>
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpcEndpointDnsName String
    The DNS name of the VPC endpoint for S3 private link.
    accessBasedEnumeration boolean
    The files and folders on this share will only be visible to users with read access. Default value is false.
    adminUserLists string[]
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    arn string
    Amazon Resource Name (ARN) of the SMB File Share.
    auditDestinationArn string
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication string
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucketRegion string
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cacheAttributes SmbFileShareCacheAttributes

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    caseSensitivity string
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    defaultStorageClass string
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    fileShareName string
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    fileshareId string
    ID of the SMB File Share.
    gatewayArn string
    Amazon Resource Name (ARN) of the file gateway.
    guessMimeTypeEnabled boolean
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalidUserLists string[]
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kmsEncrypted boolean
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kmsKeyArn string
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    locationArn string
    The ARN of the backed storage used for storing file data.
    notificationPolicy string
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    objectAcl string
    Access Control List permission for S3 objects. Defaults to private.
    oplocksEnabled boolean
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    path string
    File share path used by the NFS client to identify the mount point.
    readOnly boolean
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requesterPays boolean
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    roleArn string
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    smbAclEnabled boolean
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    validUserLists string[]
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpcEndpointDnsName string
    The DNS name of the VPC endpoint for S3 private link.
    access_based_enumeration bool
    The files and folders on this share will only be visible to users with read access. Default value is false.
    admin_user_lists Sequence[str]
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    arn str
    Amazon Resource Name (ARN) of the SMB File Share.
    audit_destination_arn str
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication str
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucket_region str
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cache_attributes SmbFileShareCacheAttributesArgs

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    case_sensitivity str
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    default_storage_class str
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    file_share_name str
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    fileshare_id str
    ID of the SMB File Share.
    gateway_arn str
    Amazon Resource Name (ARN) of the file gateway.
    guess_mime_type_enabled bool
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalid_user_lists Sequence[str]
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kms_encrypted bool
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kms_key_arn str
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    location_arn str
    The ARN of the backed storage used for storing file data.
    notification_policy str
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    object_acl str
    Access Control List permission for S3 objects. Defaults to private.
    oplocks_enabled bool
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    path str
    File share path used by the NFS client to identify the mount point.
    read_only bool
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requester_pays bool
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    role_arn str
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    smb_acl_enabled bool
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    valid_user_lists Sequence[str]
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpc_endpoint_dns_name str
    The DNS name of the VPC endpoint for S3 private link.
    accessBasedEnumeration Boolean
    The files and folders on this share will only be visible to users with read access. Default value is false.
    adminUserLists List<String>
    A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
    arn String
    Amazon Resource Name (ARN) of the SMB File Share.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
    authentication String
    The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
    bucketRegion String
    The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
    cacheAttributes Property Map

    Refresh cache information. see cache_attributes Block for more details.

    Note: If you have previously included a cache_attributes block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

    caseSensitivity String
    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    defaultStorageClass String
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
    fileShareName String
    The name of the file share. Must be set if an S3 prefix name is set in location_arn.
    fileshareId String
    ID of the SMB File Share.
    gatewayArn String
    Amazon Resource Name (ARN) of the file gateway.
    guessMimeTypeEnabled Boolean
    Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
    invalidUserLists List<String>
    A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
    kmsEncrypted Boolean
    Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.
    kmsKeyArn String
    Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kms_encrypted is true.
    locationArn String
    The ARN of the backed storage used for storing file data.
    notificationPolicy String
    The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
    objectAcl String
    Access Control List permission for S3 objects. Defaults to private.
    oplocksEnabled Boolean
    Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
    path String
    File share path used by the NFS client to identify the mount point.
    readOnly Boolean
    Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
    requesterPays Boolean
    Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.
    roleArn String
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    smbAclEnabled Boolean
    Set this value to true to enable ACL (access control list) on the SMB fileshare. Set it to false to map file and directory permissions to the POSIX permissions. This setting applies only to ActiveDirectory authentication type.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    validUserLists List<String>
    A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if authentication is set to ActiveDirectory.
    vpcEndpointDnsName String
    The DNS name of the VPC endpoint for S3 private link.

    Supporting Types

    SmbFileShareCacheAttributes, SmbFileShareCacheAttributesArgs

    CacheStaleTimeoutInSeconds int
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
    CacheStaleTimeoutInSeconds int
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
    cacheStaleTimeoutInSeconds Integer
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
    cacheStaleTimeoutInSeconds number
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
    cache_stale_timeout_in_seconds int
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
    cacheStaleTimeoutInSeconds Number
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)

    Import

    Using pulumi import, import aws_storagegateway_smb_file_share using the SMB File Share Amazon Resource Name (ARN). For example:

    $ pulumi import aws:storagegateway/smbFileShare:SmbFileShare example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws