NfsFileShareState class
Input properties used for looking up and filtering NfsFileShare resources.
Constructors
-
Creates a new NfsFileShareState.
arnARN of the NFS File Share.auditDestinationArnARN of the storage used for audit logs.bucketRegionThe region of the S3 bucket used by the file share. Required when specifyingvpcEndpointDnsName.cacheAttributesRefresh cache information. see Cache Attributes for more details.clientListsThe 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.defaultStorageClassThe default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults toS3_STANDARD.fileShareNameThe name of the file share. Must be set if an S3 prefix name is set inlocationArn.fileshareIdID of the NFS File Share.gatewayArnARN of the file gateway.guessMimeTypeEnabledBoolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults totrue.kmsEncryptedBoolean value iftrueto use Amazon S3 server side encryption with your own AWS KMS key, orfalseto use a key managed by Amazon S3. Defaults tofalse.kmsKeyArnARN for KMS key used for Amazon S3 server side encryption. This value can only be set whenkmsEncryptedis true.locationArnThe ARN of the backed storage used for storing file data.nfsFileShareDefaultsNested argument with file share default values. More information below. see NFS File Share Defaults for more details.notificationPolicyThe notification policy of the file share. For more information see the AWS Documentation. Default value is{}.objectAclAccess Control List permission for S3 objects. Defaults toprivate.pathFile share path used by the NFS client to identify the mount point.readOnlyBoolean to indicate write status of file share. File share does not accept writes iftrue. Defaults tofalse.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requesterPaysBoolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value totrueif you want the requester to pay instead of the bucket owner. Defaults tofalse.roleArnThe ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.squashMaps a user to anonymous user. Defaults toRootSquash. 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)tagsKey-value map of resource tags. .If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.vpcEndpointDnsNameThe DNS name of the VPC endpoint for S3 PrivateLink.const -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the NFS File Share.
final
-
auditDestinationArn
→ Input<
String?> ? -
ARN of the storage used for audit logs.
final
-
bucketRegion
→ Input<
String?> ? -
The region of the S3 bucket used by the file share. Required when specifying
vpcEndpointDnsName.final -
cacheAttributes
→ Input<
NfsFileShareCacheAttributes?> ? -
Refresh cache information. see Cache Attributes for more details.
final
-
clientLists
→ Input<
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.final -
defaultStorageClass
→ Input<
String?> ? -
The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to
S3_STANDARD.final -
ID of the NFS File Share.
final
-
The name of the file share. Must be set if an S3 prefix name is set in
locationArn.final -
gatewayArn
→ Input<
String?> ? -
ARN of the file gateway.
final
-
guessMimeTypeEnabled
→ Input<
bool?> ? -
Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to
true.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsEncrypted
→ Input<
bool?> ? -
Boolean value if
trueto use Amazon S3 server side encryption with your own AWS KMS key, orfalseto use a key managed by Amazon S3. Defaults tofalse.final -
kmsKeyArn
→ Input<
String?> ? -
ARN for KMS key used for Amazon S3 server side encryption. This value can only be set when
kmsEncryptedis true.final -
locationArn
→ Input<
String?> ? -
The ARN of the backed storage used for storing file data.
final
-
Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.
final
-
notificationPolicy
→ Input<
String?> ? -
The notification policy of the file share. For more information see the AWS Documentation. Default value is
{}.final -
objectAcl
→ Input<
String?> ? -
Access Control List permission for S3 objects. Defaults to
private.final -
path
→ Input<
String?> ? -
File share path used by the NFS client to identify the mount point.
final
-
readOnly
→ Input<
bool?> ? -
Boolean to indicate write status of file share. File share does not accept writes if
true. Defaults tofalse.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
requesterPays
→ Input<
bool?> ? -
Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to
trueif you want the requester to pay instead of the bucket owner. Defaults tofalse.final -
roleArn
→ Input<
String?> ? -
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
squash
→ Input<
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)final -
Key-value map of resource tags. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
vpcEndpointDnsName
→ Input<
String?> ? -
The DNS name of the VPC endpoint for S3 PrivateLink.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited