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.
Using getNfsFileShare
Two invocation forms are available. The direct form accepts plain
arguments and either blocks until the result value is available, or
returns a Promise-wrapped result. The output form accepts
Input-wrapped arguments and returns an Output-wrapped result.
def get_nfs_file_share(file_share_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNfsFileShareResult
def get_nfs_file_share_output(file_share_arn: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetNfsFileShareResult]
> Note: This function is named LookupNfsFileShare in the Go SDK.
public static CompletableFuture<GetNfsFileShareResult> getNfsFileShare(GetNfsFileShareArgs args, InvokeOptions options)
public static Output<GetNfsFileShareResult> getNfsFileShare(GetNfsFileShareArgs args, InvokeOptions options)
public static Output<GetNfsFileShareResult> getNfsFileShare(GetNfsFileShareArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:storagegateway:getNfsFileShare
arguments:
# arguments dictionary
data "aws-native_storagegateway_get_nfs_file_share" "name" {
# arguments
}
The following arguments are supported:
getNfsFileShare Result
The following output properties are available:
- AuditDestinationArn
string
- 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.
- CacheAttributes
Pulumi.AwsNative.StorageGateway.Outputs.NfsFileShareCacheAttributes
- ClientList
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.
- DefaultStorageClass
string
- 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.
- EncryptionType
Pulumi.AwsNative.StorageGateway.NfsFileShareEncryptionType
- The server-side encryption the gateway applies to objects it writes.
- FileShareArn
string
- The ARN of the file share.
- FileShareId
string
- The ID of the file share.
- FileShareName
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.
- FileShareStatus
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.
- GuessMimeTypeEnabled
bool
- Whether the gateway infers the MIME type of uploaded objects from their extension.
- KmsEncrypted
bool
- Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- KmsKey
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.
- NfsFileShareDefaults
Pulumi.AwsNative.StorageGateway.Outputs.NfsFileShareNfsFileShareDefaults
- NotificationPolicy
string
- The upload-notification settling period, as a JSON document.
- ObjectAcl
Pulumi.AwsNative.StorageGateway.NfsFileShareObjectAcl
- The canned S3 ACL applied to objects the gateway writes.
- Path
string
- The export path the share is mounted or mapped at.
- ReadOnly
bool
- Whether clients may write to the share.
- RequesterPays
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.
- Tags
List<Pulumi.AwsNative.Outputs.Tag>
- Tags assigned to the file share.
- AuditDestinationArn
string
- 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.
- CacheAttributes
NfsFileShareCacheAttributes
- ClientList
[]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.
- DefaultStorageClass
string
- 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.
- EncryptionType
NfsFileShareEncryptionType
- The server-side encryption the gateway applies to objects it writes.
- FileShareArn
string
- The ARN of the file share.
- FileShareId
string
- The ID of the file share.
- FileShareName
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.
- FileShareStatus
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.
- GuessMimeTypeEnabled
bool
- Whether the gateway infers the MIME type of uploaded objects from their extension.
- KmsEncrypted
bool
- Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- KmsKey
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.
- NfsFileShareDefaults
NfsFileShareNfsFileShareDefaults
- NotificationPolicy
string
- The upload-notification settling period, as a JSON document.
- ObjectAcl
NfsFileShareObjectAcl
- The canned S3 ACL applied to objects the gateway writes.
- Path
string
- The export path the share is mounted or mapped at.
- ReadOnly
bool
- Whether clients may write to the share.
- RequesterPays
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.
- Tags
Tag
- Tags assigned to the file share.
- audit_destination_arn
string
- 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.
- 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_class
string
- 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" | "SseKms" | "DsseKms"
- The server-side encryption the gateway applies to objects it writes.
- file_share_arn
string
- The ARN of the file share.
- file_share_id
string
- The ID of the file share.
- file_share_name
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.
- file_share_status
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.
- guess_mime_type_enabled
bool
- 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_defaults
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.
- path
string
- The export path the share is mounted or mapped at.
- 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.
- tags
list(object)
- Tags assigned to the file share.
- auditDestinationArn
String
- 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.
- cacheAttributes
NfsFileShareCacheAttributes
- clientList
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.
- defaultStorageClass
String
- 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.
- encryptionType
NfsFileShareEncryptionType
- The server-side encryption the gateway applies to objects it writes.
- fileShareArn
String
- The ARN of the file share.
- fileShareId
String
- The ID of the file share.
- fileShareName
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.
- fileShareStatus
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.
- guessMimeTypeEnabled
Boolean
- Whether the gateway infers the MIME type of uploaded objects from their extension.
- kmsEncrypted
Boolean
- Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kmsKey
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.
- nfsFileShareDefaults
NfsFileShareNfsFileShareDefaults
- notificationPolicy
String
- The upload-notification settling period, as a JSON document.
- objectAcl
NfsFileShareObjectAcl
- The canned S3 ACL applied to objects the gateway writes.
- path
String
- The export path the share is mounted or mapped at.
- readOnly
Boolean
- Whether clients may write to the share.
- requesterPays
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.
- tags
List<Tag>
- Tags assigned to the file share.
- auditDestinationArn
string
- 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.
- cacheAttributes
NfsFileShareCacheAttributes
- clientList
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.
- defaultStorageClass
string
- 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.
- encryptionType
NfsFileShareEncryptionType
- The server-side encryption the gateway applies to objects it writes.
- fileShareArn
string
- The ARN of the file share.
- fileShareId
string
- The ID of the file share.
- fileShareName
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.
- fileShareStatus
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.
- guessMimeTypeEnabled
boolean
- Whether the gateway infers the MIME type of uploaded objects from their extension.
- kmsEncrypted
boolean
- Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kmsKey
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.
- nfsFileShareDefaults
NfsFileShareNfsFileShareDefaults
- notificationPolicy
string
- The upload-notification settling period, as a JSON document.
- objectAcl
NfsFileShareObjectAcl
- The canned S3 ACL applied to objects the gateway writes.
- path
string
- The export path the share is mounted or mapped at.
- readOnly
boolean
- Whether clients may write to the share.
- requesterPays
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.
- tags
Tag[]
- Tags assigned to the file share.
- audit_destination_arn
str
- 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.
- cache_attributes
NfsFileShareCacheAttributes
- 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_class
str
- 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
NfsFileShareEncryptionType
- The server-side encryption the gateway applies to objects it writes.
- file_share_arn
str
- The ARN of the file share.
- file_share_id
str
- The ID of the file share.
- file_share_name
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.
- file_share_status
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.
- guess_mime_type_enabled
bool
- 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_defaults
NfsFileShareNfsFileShareDefaults
- notification_policy
str
- The upload-notification settling period, as a JSON document.
- object_acl
NfsFileShareObjectAcl
- The canned S3 ACL applied to objects the gateway writes.
- path
str
- The export path the share is mounted or mapped at.
- 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.
- tags
Sequence[root_Tag]
- Tags assigned to the file share.
- auditDestinationArn
String
- 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.
- cacheAttributes
Property Map
- clientList
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.
- defaultStorageClass
String
- 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.
- encryptionType
"SseS3" | "SseKms" | "DsseKms"
- The server-side encryption the gateway applies to objects it writes.
- fileShareArn
String
- The ARN of the file share.
- fileShareId
String
- The ID of the file share.
- fileShareName
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.
- fileShareStatus
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.
- guessMimeTypeEnabled
Boolean
- Whether the gateway infers the MIME type of uploaded objects from their extension.
- kmsEncrypted
Boolean
- Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable.
- kmsKey
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.
- nfsFileShareDefaults
Property Map
- notificationPolicy
String
- The upload-notification settling period, as a JSON document.
- objectAcl
"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.
- path
String
- The export path the share is mounted or mapped at.
- readOnly
Boolean
- Whether clients may write to the share.
- requesterPays
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.
- tags
List<Property Map>
- Tags assigned to the file share.
Supporting Types
NfsFileShareCacheAttributes
NfsFileShareEncryptionType
| Name | Value |
|---|
| SseS3 | SseS3 |
| SseKms | SseKms |
| DsseKms | DsseKms |
| Name | Value |
|---|
| NfsFileShareEncryptionTypeSseS3 | SseS3 |
| NfsFileShareEncryptionTypeSseKms | SseKms |
| NfsFileShareEncryptionTypeDsseKms | DsseKms |
| Name | Value |
|---|
| SseS3 | SseS3 |
| SseKms | SseKms |
| DsseKms | DsseKms |
| Name | Value |
|---|
| SseS3 | SseS3 |
| SseKms | SseKms |
| DsseKms | DsseKms |
| Name | Value |
|---|
| SSE_S3 | SseS3 |
| SSE_KMS | SseKms |
| DSSE_KMS | DsseKms |
NfsFileShareNfsFileShareDefaults
- DirectoryMode
string
- The Unix directory mode in the form nnnn.
- FileMode
string
- The Unix file mode in the form nnnn.
- GroupId
int
- The default group ID for files in the file share.
- OwnerId
int
- The default owner ID for files in the file share.
- DirectoryMode
string
- The Unix directory mode in the form nnnn.
- FileMode
string
- The Unix file mode in the form nnnn.
- GroupId
int
- The default group ID for files in the file share.
- OwnerId
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.
- directoryMode
String
- The Unix directory mode in the form nnnn.
- fileMode
String
- The Unix file mode in the form nnnn.
- groupId
Integer
- The default group ID for files in the file share.
- ownerId
Integer
- The default owner ID for files in the file share.
- directoryMode
string
- The Unix directory mode in the form nnnn.
- fileMode
string
- The Unix file mode in the form nnnn.
- groupId
number
- The default group ID for files in the file share.
- ownerId
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.
- directoryMode
String
- The Unix directory mode in the form nnnn.
- fileMode
String
- The Unix file mode in the form nnnn.
- groupId
Number
- The default group ID for files in the file share.
- ownerId
Number
- The default owner ID for files in the file share.
NfsFileShareObjectAcl
| Name | Value |
|---|
| Private | private |
| PublicRead | public-read |
| PublicReadWrite | public-read-write |
| AuthenticatedRead | authenticated-read |
| BucketOwnerRead | bucket-owner-read |
| BucketOwnerFullControl | bucket-owner-full-control |
| AwsExecRead | aws-exec-read |
| Name | Value |
|---|
| NfsFileShareObjectAclPrivate | private |
| NfsFileShareObjectAclPublicRead | public-read |
| NfsFileShareObjectAclPublicReadWrite | public-read-write |
| NfsFileShareObjectAclAuthenticatedRead | authenticated-read |
| NfsFileShareObjectAclBucketOwnerRead | bucket-owner-read |
| NfsFileShareObjectAclBucketOwnerFullControl | bucket-owner-full-control |
| NfsFileShareObjectAclAwsExecRead | 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 |
| PublicRead | public-read |
| PublicReadWrite | public-read-write |
| AuthenticatedRead | authenticated-read |
| BucketOwnerRead | bucket-owner-read |
| BucketOwnerFullControl | bucket-owner-full-control |
| AwsExecRead | aws-exec-read |
| Name | Value |
|---|
| Private | private |
| PublicRead | public-read |
| PublicReadWrite | public-read-write |
| AuthenticatedRead | authenticated-read |
| BucketOwnerRead | bucket-owner-read |
| BucketOwnerFullControl | bucket-owner-full-control |
| AwsExecRead | 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
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
str
- The key name of the tag
- value
str
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0