Class 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,
    });
}

}

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,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

SmbFileShare

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.StorageGateway

Assembly: Pulumi.Aws.dll

Syntax

public class SmbFileShare : CustomResource

Constructors

SmbFileShare(String, SmbFileShareArgs, CustomResourceOptions)

Create a SmbFileShare resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SmbFileShareArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of the SMB File Share.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Authentication

The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.

Declaration

public Output<string> Authentication { get; }

Property Value

Type	Description
Output<System.String>

DefaultStorageClass

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.

Declaration

public Output<string> DefaultStorageClass { get; }

Property Value

Type	Description
Output<System.String>

FileshareId

ID of the SMB File Share.

Declaration

public Output<string> FileshareId { get; }

Property Value

Type	Description
Output<System.String>

GatewayArn

Amazon Resource Name (ARN) of the file gateway.

Declaration

public Output<string> GatewayArn { get; }

Property Value

Type	Description
Output<System.String>

GuessMimeTypeEnabled

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

Declaration

public Output<bool?> GuessMimeTypeEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

InvalidUserLists

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.

Declaration

public Output<ImmutableArray<string>> InvalidUserLists { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

KmsEncrypted

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.

Declaration

public Output<bool?> KmsEncrypted { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

KmsKeyArn

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.

Declaration

public Output<string> KmsKeyArn { get; }

Property Value

Type	Description
Output<System.String>

LocationArn

The ARN of the backed storage used for storing file data.

Declaration

public Output<string> LocationArn { get; }

Property Value

Type	Description
Output<System.String>

ObjectAcl

Access Control List permission for S3 bucket objects. Defaults to private.

Declaration

public Output<string> ObjectAcl { get; }

Property Value

Type	Description
Output<System.String>

Path

File share path used by the NFS client to identify the mount point.

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

ReadOnly

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

Declaration

public Output<bool?> ReadOnly { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

RequesterPays

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.

Declaration

public Output<bool?> RequesterPays { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

RoleArn

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Declaration

public Output<string> RoleArn { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value map of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ValidUserLists

A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

Declaration

public Output<ImmutableArray<string>> ValidUserLists { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

Get(String, Input<String>, SmbFileShareState, CustomResourceOptions)

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

Declaration

public static SmbFileShare Get(string name, Input<string> id, SmbFileShareState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SmbFileShareState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
SmbFileShare