AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

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/v5/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/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.Any(aws_storagegateway_gateway.Example.Arn),
			LocationArn: pulumi.Any(aws_s3_bucket.Example.Arn),
			RoleArn:     pulumi.Any(aws_iam_role.Example.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var example = new NfsFileShare("example", NfsFileShareArgs.builder()        
            .clientLists("0.0.0.0/0")
            .gatewayArn(aws_storagegateway_gateway.example().arn())
            .locationArn(aws_s3_bucket.example().arn())
            .roleArn(aws_iam_role.example().arn())
            .build());

    }
}
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,
});
resources:
  example:
    type: aws:storagegateway:NfsFileShare
    properties:
      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);
@overload
def NfsFileShare(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 audit_destination_arn: Optional[str] = None,
                 bucket_region: Optional[str] = None,
                 cache_attributes: Optional[NfsFileShareCacheAttributesArgs] = None,
                 client_lists: Optional[Sequence[str]] = None,
                 default_storage_class: Optional[str] = None,
                 file_share_name: Optional[str] = None,
                 gateway_arn: Optional[str] = None,
                 guess_mime_type_enabled: Optional[bool] = None,
                 kms_encrypted: Optional[bool] = None,
                 kms_key_arn: Optional[str] = None,
                 location_arn: Optional[str] = None,
                 nfs_file_share_defaults: Optional[NfsFileShareNfsFileShareDefaultsArgs] = None,
                 notification_policy: Optional[str] = None,
                 object_acl: Optional[str] = None,
                 read_only: Optional[bool] = None,
                 requester_pays: Optional[bool] = None,
                 role_arn: Optional[str] = None,
                 squash: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 vpc_endpoint_dns_name: Optional[str] = None)
@overload
def NfsFileShare(resource_name: str,
                 args: NfsFileShareArgs,
                 opts: Optional[ResourceOptions] = None)
func NewNfsFileShare(ctx *Context, name string, args NfsFileShareArgs, opts ...ResourceOption) (*NfsFileShare, error)
public NfsFileShare(string name, NfsFileShareArgs args, CustomResourceOptions? opts = null)
public NfsFileShare(String name, NfsFileShareArgs args)
public NfsFileShare(String name, NfsFileShareArgs args, CustomResourceOptions options)
type: aws:storagegateway:NfsFileShare
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args NfsFileShareArgs
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 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.
name String
The unique name of the resource.
args NfsFileShareArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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.

AuditDestinationArn string

The Amazon Resource Name (ARN) of the storage used for audit logs.

BucketRegion string

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

CacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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. see NFS File Share Defaults for more details.

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.

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

VpcEndpointDnsName string

The DNS name of the VPC endpoint for S3 PrivateLink.

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.

AuditDestinationArn string

The Amazon Resource Name (ARN) of the storage used for audit logs.

BucketRegion string

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

CacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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. see NFS File Share Defaults for more details.

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.

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

VpcEndpointDnsName string

The DNS name of the VPC endpoint for S3 PrivateLink.

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.

auditDestinationArn String

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion String

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 NfsFileShareNfsFileShareDefaultsArgs

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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 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.

vpcEndpointDnsName String

The DNS name of the VPC endpoint for S3 PrivateLink.

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.

auditDestinationArn string

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion string

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 NfsFileShareNfsFileShareDefaultsArgs

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpcEndpointDnsName string

The DNS name of the VPC endpoint for S3 PrivateLink.

client_lists Sequence[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.

audit_destination_arn str

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucket_region str

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cache_attributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 NfsFileShareNfsFileShareDefaultsArgs

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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 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.

vpc_endpoint_dns_name str

The DNS name of the VPC endpoint for S3 PrivateLink.

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.

auditDestinationArn String

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion String

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes Property Map

Refresh cache information. see Cache Attributes for more details.

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.

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 Property Map

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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 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.

vpcEndpointDnsName String

The DNS name of the VPC endpoint for S3 PrivateLink.

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.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

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.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

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.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

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.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

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.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

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.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        audit_destination_arn: Optional[str] = None,
        bucket_region: Optional[str] = None,
        cache_attributes: Optional[NfsFileShareCacheAttributesArgs] = None,
        client_lists: Optional[Sequence[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,
        kms_encrypted: Optional[bool] = None,
        kms_key_arn: Optional[str] = None,
        location_arn: Optional[str] = None,
        nfs_file_share_defaults: Optional[NfsFileShareNfsFileShareDefaultsArgs] = None,
        notification_policy: Optional[str] = None,
        object_acl: Optional[str] = None,
        path: Optional[str] = None,
        read_only: Optional[bool] = None,
        requester_pays: Optional[bool] = None,
        role_arn: Optional[str] = None,
        squash: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_endpoint_dns_name: Optional[str] = None) -> NfsFileShare
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)
public static NfsFileShare get(String name, Output<String> id, NfsFileShareState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Arn string

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

AuditDestinationArn string

The Amazon Resource Name (ARN) of the storage used for audit logs.

BucketRegion string

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

CacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 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. see NFS File Share Defaults for more details.

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.

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. .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 .

VpcEndpointDnsName string

The DNS name of the VPC endpoint for S3 PrivateLink.

Arn string

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

AuditDestinationArn string

The Amazon Resource Name (ARN) of the storage used for audit logs.

BucketRegion string

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

CacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 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. see NFS File Share Defaults for more details.

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.

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. .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 .

VpcEndpointDnsName string

The DNS name of the VPC endpoint for S3 PrivateLink.

arn String

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

auditDestinationArn String

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion String

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 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 NfsFileShareNfsFileShareDefaultsArgs

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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 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 .

vpcEndpointDnsName String

The DNS name of the VPC endpoint for S3 PrivateLink.

arn string

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

auditDestinationArn string

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion string

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

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.

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 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 NfsFileShareNfsFileShareDefaultsArgs

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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. .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 .

vpcEndpointDnsName string

The DNS name of the VPC endpoint for S3 PrivateLink.

arn str

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

audit_destination_arn str

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucket_region str

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cache_attributes NfsFileShareCacheAttributesArgs

Refresh cache information. see Cache Attributes for more details.

client_lists Sequence[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.

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 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 NfsFileShareNfsFileShareDefaultsArgs

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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 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 .

vpc_endpoint_dns_name str

The DNS name of the VPC endpoint for S3 PrivateLink.

arn String

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

auditDestinationArn String

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion String

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes Property Map

Refresh cache information. see Cache Attributes for more details.

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.

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 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 Property Map

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

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.

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 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 .

vpcEndpointDnsName String

The DNS name of the VPC endpoint for S3 PrivateLink.

Supporting Types

NfsFileShareCacheAttributes

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)

NfsFileShareNfsFileShareDefaults

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 string

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 string

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 string

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 string

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 String

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 String

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 string

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 string

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.

directory_mode str

The Unix directory mode in the string form "nnnn". Defaults to "0777".

file_mode str

The Unix file mode in the string form "nnnn". Defaults to "0666".

group_id str

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 str

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 String

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 String

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.

Import

aws_storagegateway_nfs_file_share can be imported by using the NFS File Share Amazon Resource Name (ARN), e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.