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

}

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.NewNfsFileShare(ctx, "example", &storagegateway.NfsFileShareArgs{
            ClientLists: pulumi.StringArray{
                pulumi.String("0.0.0.0/0"),
            },
            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.NfsFileShare("example",
    client_lists=["0.0.0.0/0"],
    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.NfsFileShare("example", {
    clientLists: ["0.0.0.0/0"],
    gatewayArn: aws_storagegateway_gateway_example.arn,
    locationArn: aws_s3_bucket_example.arn,
    roleArn: aws_iam_role_example.arn,
});

Create a NfsFileShare Resource

new NfsFileShare(name: string, args: NfsFileShareArgs, opts?: CustomResourceOptions);

def NfsFileShare(resource_name, opts=None, client_lists=None, default_storage_class=None, gateway_arn=None, guess_mime_type_enabled=None, kms_encrypted=None, kms_key_arn=None, location_arn=None, nfs_file_share_defaults=None, object_acl=None, read_only=None, requester_pays=None, role_arn=None, squash=None, tags=None, __props__=None);

func NewNfsFileShare(ctx *Context, name string, args NfsFileShareArgs, opts ...ResourceOption) (*NfsFileShare, error)

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

name string: The unique name of the resource.
args NfsFileShareArgs: 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 NfsFileShareArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NfsFileShareArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NfsFileShare Resource Properties

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

Inputs

The NfsFileShare resource accepts the following input properties:

ClientLists List<string>: 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.
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.
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.
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.
NfsFileShareDefaults NfsFileShareNfsFileShareDefaultsArgs: Nested argument with file share default values. More information below.
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.
Squash string: 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)
Tags Dictionary<string, string>: Key-value map of resource tags

ClientLists []string: 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.
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.
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.
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.
NfsFileShareDefaults NfsFileShareNfsFileShareDefaults: Nested argument with file share default values. More information below.
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.
Squash string: 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)
Tags map[string]string: Key-value map of resource tags

clientLists string[]: 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.
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.
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.
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.
nfsFileShareDefaults NfsFileShareNfsFileShareDefaults: Nested argument with file share default values. More information below.
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.
squash string: 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)
tags {[key: string]: string}: Key-value map of resource tags

client_lists List[str]: 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.
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.
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.
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.
nfs_file_share_defaults Dict[NfsFileShareNfsFileShareDefaults]: Nested argument with file share default values. More information below.
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.
squash str: 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)
tags Dict[str, str]: Key-value map of resource tags

Outputs

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

Arn string: Amazon Resource Name (ARN) of the NFS File Share.
FileshareId string: ID of the NFS 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 NFS File Share.
FileshareId string: ID of the NFS 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 NFS File Share.
fileshareId string: ID of the NFS 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 NFS File Share.
fileshare_id str: ID of the NFS 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 NfsFileShare Resource

Get an existing NfsFileShare 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?: NfsFileShareState, opts?: CustomResourceOptions): NfsFileShare

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

func GetNfsFileShare(ctx *Context, name string, id IDInput, state *NfsFileShareState, opts ...ResourceOption) (*NfsFileShare, error)

public static NfsFileShare Get(string name, Input<string> id, NfsFileShareState? 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 NFS File Share.
ClientLists List<string>: 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.
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 NFS 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.
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.
NfsFileShareDefaults NfsFileShareNfsFileShareDefaultsArgs: Nested argument with file share default values. More information below.
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.
Squash string: 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)
Tags Dictionary<string, string>: Key-value map of resource tags

Arn string: Amazon Resource Name (ARN) of the NFS File Share.
ClientLists []string: 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.
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 NFS 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.
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.
NfsFileShareDefaults NfsFileShareNfsFileShareDefaults: Nested argument with file share default values. More information below.
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.
Squash string: 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)
Tags map[string]string: Key-value map of resource tags

arn string: Amazon Resource Name (ARN) of the NFS File Share.
clientLists string[]: 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.
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 NFS 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.
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.
nfsFileShareDefaults NfsFileShareNfsFileShareDefaults: Nested argument with file share default values. More information below.
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.
squash string: 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)
tags {[key: string]: string}: Key-value map of resource tags

arn str: Amazon Resource Name (ARN) of the NFS File Share.
client_lists List[str]: 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.
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 NFS 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.
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.
nfs_file_share_defaults Dict[NfsFileShareNfsFileShareDefaults]: Nested argument with file share default values. More information below.
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.
squash str: 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)
tags Dict[str, str]: Key-value map of resource tags

Supporting Types

NfsFileShareNfsFileShareDefaults

See the input and output API doc for this type.

DirectoryMode string: The Unix directory mode in the string form “nnnn”. Defaults to "0777".
FileMode string: The Unix file mode in the string form “nnnn”. Defaults to "0666".
GroupId int: The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
OwnerId int: The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

DirectoryMode string: The Unix directory mode in the string form “nnnn”. Defaults to "0777".
FileMode string: The Unix file mode in the string form “nnnn”. Defaults to "0666".
GroupId int: The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
OwnerId int: The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

directoryMode string: The Unix directory mode in the string form “nnnn”. Defaults to "0777".
fileMode string: The Unix file mode in the string form “nnnn”. Defaults to "0666".
groupId number: The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
ownerId number: The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

directoryMode str: The Unix directory mode in the string form “nnnn”. Defaults to "0777".
fileMode str: The Unix file mode in the string form “nnnn”. Defaults to "0666".
groupId float: The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
owner_id float: The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

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