Class NfsFileShare

Manages an AWS Storage Gateway NFS File Share.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.StorageGateway.NfsFileShare("example", new Aws.StorageGateway.NfsFileShareArgs
    {
        ClientLists = 
        {
            "0.0.0.0/0",
        },
        GatewayArn = aws_storagegateway_gateway.Example.Arn,
        LocationArn = aws_s3_bucket.Example.Arn,
        RoleArn = aws_iam_role.Example.Arn,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

NfsFileShare

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 NfsFileShare : CustomResource

Constructors

NfsFileShare(String, NfsFileShareArgs, CustomResourceOptions)

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

Declaration

public NfsFileShare(string name, NfsFileShareArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NfsFileShareArgs	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 NFS File Share.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

ClientLists

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to ["0.0.0.0/0"] to not limit access. Minimum 1 item. Maximum 100 items.

Declaration

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

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<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 NFS 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>>

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>

NfsFileShareDefaults

Nested argument with file share default values. More information below.

Declaration

public Output<NfsFileShareNfsFileShareDefaults> NfsFileShareDefaults { get; }

Property Value

Type	Description
Output<NfsFileShareNfsFileShareDefaults>

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>

Squash

Maps a user to anonymous user. Defaults to RootSquash. Valid values: RootSquash (only root is mapped to anonymous user), NoSquash (no one is mapped to anonymous user), AllSquash (everyone is mapped to anonymous user)

Declaration

public Output<string> Squash { 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>>

Methods

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

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

Declaration

public static NfsFileShare Get(string name, Input<string> id, NfsFileShareState 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.
NfsFileShareState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NfsFileShare