We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::StorageGateway::NFSFileShare. An NFS file share exposes an Amazon S3 bucket through a Storage Gateway file gateway, so clients read and write objects as files over NFS. The share’s variant is fixed by its resource type rather than by a property: the service constructs the two variants with different APIs, and a property carrying the choice would belong to neither API’s input.
Create NfsFileShare Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NfsFileShare(name: string, args: NfsFileShareArgs, opts?: CustomResourceOptions);@overload
def NfsFileShare(resource_name: str,
args: NfsFileShareArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NfsFileShare(resource_name: str,
opts: Optional[ResourceOptions] = None,
gateway_arn: Optional[str] = None,
role: Optional[str] = None,
location_arn: Optional[str] = None,
kms_key: Optional[str] = None,
nfs_file_share_defaults: Optional[NfsFileShareNfsFileShareDefaultsArgs] = None,
encryption_type: Optional[NfsFileShareEncryptionType] = None,
file_share_name: Optional[str] = None,
client_list: Optional[Sequence[str]] = None,
guess_mime_type_enabled: Optional[bool] = None,
kms_encrypted: Optional[bool] = None,
audit_destination_arn: Optional[str] = None,
cache_attributes: Optional[NfsFileShareCacheAttributesArgs] = None,
default_storage_class: Optional[str] = None,
notification_policy: Optional[str] = None,
object_acl: Optional[NfsFileShareObjectAcl] = None,
read_only: Optional[bool] = None,
requester_pays: Optional[bool] = None,
bucket_region: Optional[str] = None,
squash: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
vpc_endpoint_dns_name: Optional[str] = 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-native:storagegateway:NfsFileShare
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_storagegateway_nfs_file_share" "name" {
# resource properties
}Parameters
- 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NfsFileShare resource accepts the following input properties:
- Gateway
Arn string - The ARN of the S3 File Gateway that hosts the share.
- Location
Arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- Role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- Audit
Destination stringArn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- Bucket
Region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- Cache
Attributes Pulumi.Aws Native. Storage Gateway. Inputs. Nfs File Share Cache Attributes - Client
List List<string> - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- Default
Storage stringClass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- Encryption
Type Pulumi.Aws Native. Storage Gateway. Nfs File Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- string
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- Guess
Mime boolType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- Kms
Encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- Kms
Key string - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
-
Pulumi.
Aws Native. Storage Gateway. Inputs. Nfs File Share Nfs File Share Defaults - Notification
Policy string - The upload-notification settling period, as a JSON document.
- Object
Acl Pulumi.Aws Native. Storage Gateway. Nfs File Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- Read
Only bool - Whether clients may write to the share.
- Requester
Pays bool - Whether the bucket is a Requester Pays bucket.
- Squash string
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Tags assigned to the file share.
- Vpc
Endpoint stringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- Gateway
Arn string - The ARN of the S3 File Gateway that hosts the share.
- Location
Arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- Role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- Audit
Destination stringArn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- Bucket
Region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- Cache
Attributes NfsFile Share Cache Attributes Args - Client
List []string - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- Default
Storage stringClass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- Encryption
Type NfsFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- string
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- Guess
Mime boolType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- Kms
Encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- Kms
Key string - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
-
Nfs
File Share Nfs File Share Defaults Args - Notification
Policy string - The upload-notification settling period, as a JSON document.
- Object
Acl NfsFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- Read
Only bool - Whether clients may write to the share.
- Requester
Pays bool - Whether the bucket is a Requester Pays bucket.
- Squash string
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
-
Tag
Args - Tags assigned to the file share.
- Vpc
Endpoint stringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway_
arn string - The ARN of the S3 File Gateway that hosts the share.
- location_
arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- audit_
destination_ stringarn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- bucket_
region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache_
attributes object - client_
list list(string) - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- default_
storage_ stringclass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- encryption_
type "SseS3" | "Sse Kms" | "Dsse Kms" - The server-side encryption the gateway applies to objects it writes.
- string
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- guess_
mime_ booltype_ enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- kms_
encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms_
key string - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- object
- notification_
policy string - The upload-notification settling period, as a JSON document.
- object_
acl "private" | "public-read" | "public-read-write" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "aws-exec-read" - The canned S3 ACL applied to objects the gateway writes.
- read_
only bool - Whether clients may write to the share.
- requester_
pays bool - Whether the bucket is a Requester Pays bucket.
- squash string
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
- list(object)
- Tags assigned to the file share.
- vpc_
endpoint_ stringdns_ name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway
Arn String - The ARN of the S3 File Gateway that hosts the share.
- location
Arn String - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role String
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- audit
Destination StringArn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- bucket
Region String - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache
Attributes NfsFile Share Cache Attributes - client
List List<String> - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- default
Storage StringClass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- encryption
Type NfsFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- String
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- guess
Mime BooleanType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- kms
Encrypted Boolean - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms
Key String - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
-
Nfs
File Share Nfs File Share Defaults - notification
Policy String - The upload-notification settling period, as a JSON document.
- object
Acl NfsFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- read
Only Boolean - Whether clients may write to the share.
- requester
Pays Boolean - Whether the bucket is a Requester Pays bucket.
- squash String
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
- List<Tag>
- Tags assigned to the file share.
- vpc
Endpoint StringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway
Arn string - The ARN of the S3 File Gateway that hosts the share.
- location
Arn string - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role string
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- audit
Destination stringArn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- bucket
Region string - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache
Attributes NfsFile Share Cache Attributes - client
List string[] - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- default
Storage stringClass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- encryption
Type NfsFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- string
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- guess
Mime booleanType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- kms
Encrypted boolean - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms
Key string - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
-
Nfs
File Share Nfs File Share Defaults - notification
Policy string - The upload-notification settling period, as a JSON document.
- object
Acl NfsFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- read
Only boolean - Whether clients may write to the share.
- requester
Pays boolean - Whether the bucket is a Requester Pays bucket.
- squash string
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
- Tag[]
- Tags assigned to the file share.
- vpc
Endpoint stringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway_
arn str - The ARN of the S3 File Gateway that hosts the share.
- location_
arn str - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role str
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- audit_
destination_ strarn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- bucket_
region str - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache_
attributes NfsFile Share Cache Attributes Args - client_
list Sequence[str] - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- default_
storage_ strclass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- encryption_
type NfsFile Share Encryption Type - The server-side encryption the gateway applies to objects it writes.
- str
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- guess_
mime_ booltype_ enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- kms_
encrypted bool - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms_
key str - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
-
Nfs
File Share Nfs File Share Defaults Args - notification_
policy str - The upload-notification settling period, as a JSON document.
- object_
acl NfsFile Share Object Acl - The canned S3 ACL applied to objects the gateway writes.
- read_
only bool - Whether clients may write to the share.
- requester_
pays bool - Whether the bucket is a Requester Pays bucket.
- squash str
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
-
Sequence[Tag
Args] - Tags assigned to the file share.
- vpc_
endpoint_ strdns_ name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
- gateway
Arn String - The ARN of the S3 File Gateway that hosts the share.
- location
Arn String - The ARN of the S3 bucket, or bucket prefix, the share exposes.
- role String
- The ARN of the IAM role the gateway assumes when it accesses the S3 location.
- audit
Destination StringArn - The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset.
- bucket
Region String - The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
- cache
Attributes Property Map - client
List List<String> - The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- default
Storage StringClass - The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration.
- encryption
Type "SseS3" | "Sse Kms" | "Dsse Kms" - The server-side encryption the gateway applies to objects it writes.
- String
- The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- guess
Mime BooleanType Enabled - Whether the gateway infers the MIME type of uploaded objects from their extension.
- kms
Encrypted Boolean - Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kms
Key String - The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- Property Map
- notification
Policy String - The upload-notification settling period, as a JSON document.
- object
Acl "private" | "public-read" | "public-read-write" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "aws-exec-read" - The canned S3 ACL applied to objects the gateway writes.
- read
Only Boolean - Whether clients may write to the share.
- requester
Pays Boolean - Whether the bucket is a Requester Pays bucket.
- squash String
- How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration.
- List<Property Map>
- Tags assigned to the file share.
- vpc
Endpoint StringDns Name - The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.
Outputs
All input properties are implicitly available as output properties. Additionally, the NfsFileShare resource produces the following output properties:
- string
- The ARN of the file share.
- string
- The ID of the file share.
- string
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Path string
- The export path the share is mounted or mapped at.
- string
- The ARN of the file share.
- string
- The ID of the file share.
- string
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Path string
- The export path the share is mounted or mapped at.
- string
- The ARN of the file share.
- string
- The ID of the file share.
- string
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- id string
- The provider-assigned unique ID for this managed resource.
- path string
- The export path the share is mounted or mapped at.
- String
- The ARN of the file share.
- String
- The ID of the file share.
- String
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- id String
- The provider-assigned unique ID for this managed resource.
- path String
- The export path the share is mounted or mapped at.
- string
- The ARN of the file share.
- string
- The ID of the file share.
- string
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- id string
- The provider-assigned unique ID for this managed resource.
- path string
- The export path the share is mounted or mapped at.
- str
- The ARN of the file share.
- str
- The ID of the file share.
- str
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- id str
- The provider-assigned unique ID for this managed resource.
- path str
- The export path the share is mounted or mapped at.
- String
- The ARN of the file share.
- String
- The ID of the file share.
- String
- The status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
- id String
- The provider-assigned unique ID for this managed resource.
- path String
- The export path the share is mounted or mapped at.
Look up 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>, opts?: CustomResourceOptions): NfsFileShare@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> NfsFileSharefunc GetNfsFileShare(ctx *Context, name string, id IDInput, state *NfsFileShareState, opts ...ResourceOption) (*NfsFileShare, error)public static NfsFileShare Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static NfsFileShare get(String name, Output<String> id, CustomResourceOptions options)resources: existingNfsFileShare: type: aws-native:storagegateway:NfsFileShare get: id: ${id}import {
to = aws-native_storagegateway_nfs_file_share.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state NfsFileShareState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
NfsFileShareCacheAttributes, NfsFileShareCacheAttributesArgs
Refresh cache information for the file share. Removing this property from a template leaves the share's current value: the service documents no value that resets it.
- Cache
Stale intTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- Cache
Stale intTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- cache_
stale_ numbertimeout_ in_ seconds - How long the directory contents cached by the gateway are considered valid.
- cache
Stale IntegerTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- cache
Stale numberTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
- cache_
stale_ inttimeout_ in_ seconds - How long the directory contents cached by the gateway are considered valid.
- cache
Stale NumberTimeout In Seconds - How long the directory contents cached by the gateway are considered valid.
NfsFileShareEncryptionType
The server-side encryption the gateway applies to objects it writes.
| Name | Value |
|---|---|
| Sse | SseS3 |
| Sse | SseKms |
| Dsse | DsseKms |
| Name | Value |
|---|---|
| Nfs | SseS3 |
| Nfs | SseKms |
| Nfs | DsseKms |
| Value |
|---|
SseS3 |
SseKms |
DsseKms |
| Name | Value |
|---|---|
| Sse | SseS3 |
| Sse | SseKms |
| Dsse | DsseKms |
| Name | Value |
|---|---|
| Sse | SseS3 |
| Sse | SseKms |
| Dsse | DsseKms |
| Name | Value |
|---|---|
| SSE_S3 | SseS3 |
| SSE_KMS | SseKms |
| DSSE_KMS | DsseKms |
| Value |
|---|
SseS3 |
SseKms |
DsseKms |
NfsFileShareNfsFileShareDefaults, NfsFileShareNfsFileShareDefaultsArgs
Default values for the file and directory permissions of an NFS share. Removing this property from a template leaves the live values unchanged rather than clearing them, because the service has no reset for it: a create that omits the object leaves it absent, but the update path merges member by member keyed on the same internal sentinel that reports absence, so no request can restore that state. Set the members you want rather than relying on removal.
- Directory
Mode string - The Unix directory mode in the form nnnn.
- File
Mode string - The Unix file mode in the form nnnn.
- Group
Id int - The default group ID for files in the file share.
- Owner
Id int - The default owner ID for files in the file share.
- Directory
Mode string - The Unix directory mode in the form nnnn.
- File
Mode string - The Unix file mode in the form nnnn.
- Group
Id int - The default group ID for files in the file share.
- Owner
Id int - The default owner ID for files in the file share.
- directory_
mode string - The Unix directory mode in the form nnnn.
- file_
mode string - The Unix file mode in the form nnnn.
- group_
id number - The default group ID for files in the file share.
- owner_
id number - The default owner ID for files in the file share.
- directory
Mode String - The Unix directory mode in the form nnnn.
- file
Mode String - The Unix file mode in the form nnnn.
- group
Id Integer - The default group ID for files in the file share.
- owner
Id Integer - The default owner ID for files in the file share.
- directory
Mode string - The Unix directory mode in the form nnnn.
- file
Mode string - The Unix file mode in the form nnnn.
- group
Id number - The default group ID for files in the file share.
- owner
Id number - The default owner ID for files in the file share.
- directory_
mode str - The Unix directory mode in the form nnnn.
- file_
mode str - The Unix file mode in the form nnnn.
- group_
id int - The default group ID for files in the file share.
- owner_
id int - The default owner ID for files in the file share.
- directory
Mode String - The Unix directory mode in the form nnnn.
- file
Mode String - The Unix file mode in the form nnnn.
- group
Id Number - The default group ID for files in the file share.
- owner
Id Number - The default owner ID for files in the file share.
NfsFileShareObjectAcl
The canned S3 ACL applied to objects the gateway writes.
| Name | Value |
|---|---|
| Private | private |
| Public | public-read |
| Public | public-read-write |
| Authenticated | authenticated-read |
| Bucket | bucket-owner-read |
| Bucket | bucket-owner-full-control |
| Aws | aws-exec-read |
| Name | Value |
|---|---|
| Nfs | private |
| Nfs | public-read |
| Nfs | public-read-write |
| Nfs | authenticated-read |
| Nfs | bucket-owner-read |
| Nfs | bucket-owner-full-control |
| Nfs | aws-exec-read |
| Value |
|---|
private |
public-read |
public-read-write |
authenticated-read |
bucket-owner-read |
bucket-owner-full-control |
aws-exec-read |
| Name | Value |
|---|---|
| Private | private |
| Public | public-read |
| Public | public-read-write |
| Authenticated | authenticated-read |
| Bucket | bucket-owner-read |
| Bucket | bucket-owner-full-control |
| Aws | aws-exec-read |
| Name | Value |
|---|---|
| Private | private |
| Public | public-read |
| Public | public-read-write |
| Authenticated | authenticated-read |
| Bucket | bucket-owner-read |
| Bucket | bucket-owner-full-control |
| Aws | aws-exec-read |
| Name | Value |
|---|---|
| PRIVATE | private |
| PUBLIC_READ | public-read |
| PUBLIC_READ_WRITE | public-read-write |
| AUTHENTICATED_READ | authenticated-read |
| BUCKET_OWNER_READ | bucket-owner-read |
| BUCKET_OWNER_FULL_CONTROL | bucket-owner-full-control |
| AWS_EXEC_READ | aws-exec-read |
| Value |
|---|
private |
public-read |
public-read-write |
authenticated-read |
bucket-owner-read |
bucket-owner-full-control |
aws-exec-read |
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi