SmbFileShare

Manages an AWS Storage Gateway SMB File Share.

Example Usage

Active Directory Authentication

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.StorageGateway.SmbFileShare("example", new Aws.StorageGateway.SmbFileShareArgs
        {
            Authentication = "ActiveDirectory",
            GatewayArn = aws_storagegateway_gateway.Example.Arn,
            LocationArn = aws_s3_bucket.Example.Arn,
            RoleArn = aws_iam_role.Example.Arn,
        });
    }

}

package main

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

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

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.SmbFileShare("example",
    authentication="ActiveDirectory",
    gateway_arn=aws_storagegateway_gateway["example"]["arn"],
    location_arn=aws_s3_bucket["example"]["arn"],
    role_arn=aws_iam_role["example"]["arn"])

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

const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "ActiveDirectory",
    gatewayArn: aws_storagegateway_gateway_example.arn,
    locationArn: aws_s3_bucket_example.arn,
    roleArn: aws_iam_role_example.arn,
});

Guest Authentication

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.StorageGateway.SmbFileShare("example", new Aws.StorageGateway.SmbFileShareArgs
        {
            Authentication = "GuestAccess",
            GatewayArn = aws_storagegateway_gateway.Example.Arn,
            LocationArn = aws_s3_bucket.Example.Arn,
            RoleArn = aws_iam_role.Example.Arn,
        });
    }

}

package main

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

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

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.SmbFileShare("example",
    authentication="GuestAccess",
    gateway_arn=aws_storagegateway_gateway["example"]["arn"],
    location_arn=aws_s3_bucket["example"]["arn"],
    role_arn=aws_iam_role["example"]["arn"])

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

const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "GuestAccess",
    gatewayArn: aws_storagegateway_gateway_example.arn,
    locationArn: aws_s3_bucket_example.arn,
    roleArn: aws_iam_role_example.arn,
});

Create a SmbFileShare Resource

new SmbFileShare(name: string, args: SmbFileShareArgs, opts?: CustomResourceOptions);

def SmbFileShare(resource_name, opts=None, authentication=None, default_storage_class=None, gateway_arn=None, guess_mime_type_enabled=None, invalid_user_lists=None, kms_encrypted=None, kms_key_arn=None, location_arn=None, object_acl=None, read_only=None, requester_pays=None, role_arn=None, tags=None, valid_user_lists=None, __props__=None);

func NewSmbFileShare(ctx *Context, name string, args SmbFileShareArgs, opts ...ResourceOption) (*SmbFileShare, error)

public SmbFileShare(string name, SmbFileShareArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

SmbFileShare Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

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.
Authentication string: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
DefaultStorageClass string: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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.
ObjectAcl string: Access Control List permission for S3 bucket objects. Defaults to private.
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.
Tags Dictionary<string, string>: Key-value map of resource tags
ValidUserLists List<string>: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

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.
Authentication string: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
DefaultStorageClass string: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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.
ObjectAcl string: Access Control List permission for S3 bucket objects. Defaults to private.
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.
Tags map[string]string: Key-value map of resource tags
ValidUserLists []string: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

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.
authentication string: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
defaultStorageClass string: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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.
objectAcl string: Access Control List permission for S3 bucket objects. Defaults to private.
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.
tags {[key: string]: string}: Key-value map of resource tags
validUserLists string[]: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

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.
authentication str: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
default_storage_class str: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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 List[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.
object_acl str: Access Control List permission for S3 bucket objects. Defaults to private.
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.
tags Dict[str, str]: Key-value map of resource tags
valid_user_lists List[str]: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

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.

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.

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.

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.

Look up an 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

static get(resource_name, id, opts=None, arn=None, authentication=None, default_storage_class=None, fileshare_id=None, gateway_arn=None, guess_mime_type_enabled=None, invalid_user_lists=None, kms_encrypted=None, kms_key_arn=None, location_arn=None, object_acl=None, path=None, read_only=None, requester_pays=None, role_arn=None, tags=None, valid_user_lists=None, __props__=None);

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)

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.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN) of the SMB File Share.
Authentication string: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
DefaultStorageClass string: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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.
ObjectAcl string: Access Control List permission for S3 bucket objects. Defaults to private.
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.
Tags Dictionary<string, string>: Key-value map of resource tags
ValidUserLists List<string>: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

Arn string: Amazon Resource Name (ARN) of the SMB File Share.
Authentication string: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
DefaultStorageClass string: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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.
ObjectAcl string: Access Control List permission for S3 bucket objects. Defaults to private.
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.
Tags map[string]string: Key-value map of resource tags
ValidUserLists []string: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

arn string: Amazon Resource Name (ARN) of the SMB File Share.
authentication string: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
defaultStorageClass string: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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.
objectAcl string: Access Control List permission for S3 bucket objects. Defaults to private.
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.
tags {[key: string]: string}: Key-value map of resource tags
validUserLists string[]: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

arn str: Amazon Resource Name (ARN) of the SMB File Share.
authentication str: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
default_storage_class str: The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.
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 List[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.
object_acl str: Access Control List permission for S3 bucket objects. Defaults to private.
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.
tags Dict[str, str]: Key-value map of resource tags
valid_user_lists List[str]: A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud