CfnNFSFileShareProps Struct Added in v2.275.0
Properties for defining a CfnNFSFileShare.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_storagegateway as storagegateway } from 'aws-cdk-lib';
const cfnNFSFileShareProps: storagegateway.CfnNFSFileShareProps = {
gatewayArn: 'gatewayArn',
locationArn: 'locationArn',
role: 'role',
// the properties below are optional
auditDestinationArn: 'auditDestinationArn',
bucketRegion: 'bucketRegion',
cacheAttributes: {
cacheStaleTimeoutInSeconds: 123,
},
clientList: ['clientList'],
defaultStorageClass: 'defaultStorageClass',
encryptionType: 'encryptionType',
fileShareName: 'fileShareName',
guessMimeTypeEnabled: false,
kmsEncrypted: false,
kmsKey: 'kmsKey',
nfsFileShareDefaults: {
directoryMode: 'directoryMode',
fileMode: 'fileMode',
groupId: 123,
ownerId: 123,
},
notificationPolicy: 'notificationPolicy',
objectAcl: 'objectAcl',
readOnly: false,
requesterPays: false,
squash: 'squash',
tags: [{
key: 'key',
value: 'value',
}],
vpcEndpointDnsName: 'vpcEndpointDnsName',
};
Properties
auditDestinationArnoptionalstringaudit_destination_arnoptionalstrauditDestinationArnoptionalStringAuditDestinationArnoptionalstringAuditDestinationArnoptional*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.
bucketRegionoptionalstringbucket_regionoptionalstrbucketRegionoptionalStringBucketRegionoptionalstringBucketRegionoptional*string#The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint.
cacheAttributesoptionalIResolvable | CfnNFSFileShare.CacheAttributesPropertycache_attributesoptionaltyping.Union[IResolvable, CacheAttributesProperty]cacheAttributesoptionalIResolvableCacheAttributesoptionalIResolvableCacheAttributesoptionalinterface{}#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.
clientListoptionalstring[]client_listoptionaltyping.List[str]clientListoptionalList<String>ClientListoptionalstring[]ClientListoptional*[]*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.
defaultStorageClassoptionalstringdefault_storage_classoptionalstrdefaultStorageClassoptionalStringDefaultStorageClassoptionalstringDefaultStorageClassoptional*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.
encryptionTypeoptionalstringencryption_typeoptionalstrencryptionTypeoptionalStringEncryptionTypeoptionalstringEncryptionTypeoptional*string#The server-side encryption the gateway applies to objects it writes.
The ARN of the S3 File Gateway that hosts the share.
guessMimeTypeEnabledoptionalboolean | IResolvableguess_mime_type_enabledoptionaltyping.Union[bool, IResolvable]guessMimeTypeEnabledoptionalBooleanGuessMimeTypeEnabledoptionalboolGuessMimeTypeEnabledoptionalinterface{}#Whether the gateway infers the MIME type of uploaded objects from their extension.
kmsEncryptedoptionalboolean | IResolvablekms_encryptedoptionaltyping.Union[bool, IResolvable]kmsEncryptedoptionalBooleanKmsEncryptedoptionalboolKmsEncryptedoptionalinterface{}#Deprecated by the service in favour of EncryptionType;
true selects KMS encryption. Retained because it remains readable and settable.
kmsKeyoptionalstringkms_keyoptionalstrkmsKeyoptionalStringKmsKeyoptionalstringKmsKeyoptional*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.
The ARN of the S3 bucket, or bucket prefix, the share exposes.
notificationPolicyoptionalstringnotification_policyoptionalstrnotificationPolicyoptionalStringNotificationPolicyoptionalstringNotificationPolicyoptional*string#The upload-notification settling period, as a JSON document.
objectAcloptionalstringobject_acloptionalstrobjectAcloptionalStringObjectAcloptionalstringObjectAcloptional*string#The canned S3 ACL applied to objects the gateway writes.
readOnlyoptionalboolean | IResolvableread_onlyoptionaltyping.Union[bool, IResolvable]readOnlyoptionalBooleanReadOnlyoptionalboolReadOnlyoptionalinterface{}#Whether clients may write to the share.
requesterPaysoptionalboolean | IResolvablerequester_paysoptionaltyping.Union[bool, IResolvable]requesterPaysoptionalBooleanRequesterPaysoptionalboolRequesterPaysoptionalinterface{}#Whether the bucket is a Requester Pays bucket.
The ARN of the IAM role the gateway assumes when it accesses the S3 location.
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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Tags assigned to the file share.
vpcEndpointDnsNameoptionalstringvpc_endpoint_dns_nameoptionalstrvpcEndpointDnsNameoptionalStringVpcEndpointDnsNameoptionalstringVpcEndpointDnsNameoptional*string#The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket.