Interface NFSFileShareInfo.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<NFSFileShareInfo.Builder,
,NFSFileShareInfo> SdkBuilder<NFSFileShareInfo.Builder,
,NFSFileShareInfo> SdkPojo
- Enclosing class:
NFSFileShareInfo
-
Method Summary
Modifier and TypeMethodDescriptionauditDestinationARN
(String auditDestinationARN) The Amazon Resource Name (ARN) of the storage used for audit logs.bucketRegion
(String bucketRegion) Specifies the Region of the S3 bucket where the NFS file share stores files.default NFSFileShareInfo.Builder
cacheAttributes
(Consumer<CacheAttributes.Builder> cacheAttributes) Refresh cache information for the file share.cacheAttributes
(CacheAttributes cacheAttributes) Refresh cache information for the file share.clientList
(String... clientList) Sets the value of the ClientList property for this object.clientList
(Collection<String> clientList) Sets the value of the ClientList property for this object.defaultStorageClass
(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.fileShareARN
(String fileShareARN) Sets the value of the FileShareARN property for this object.fileShareId
(String fileShareId) Sets the value of the FileShareId property for this object.fileShareName
(String fileShareName) The name of the file share.fileShareStatus
(String fileShareStatus) Sets the value of the FileShareStatus property for this object.gatewayARN
(String gatewayARN) Sets the value of the GatewayARN property for this object.guessMIMETypeEnabled
(Boolean guessMIMETypeEnabled) A value that enables guessing of the MIME type for uploaded objects based on file extensions.kmsEncrypted
(Boolean kmsEncrypted) Set totrue
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3.Sets the value of the KMSKey property for this object.locationARN
(String locationARN) Sets the value of the LocationARN property for this object.default NFSFileShareInfo.Builder
nfsFileShareDefaults
(Consumer<NFSFileShareDefaults.Builder> nfsFileShareDefaults) Sets the value of the NFSFileShareDefaults property for this object.nfsFileShareDefaults
(NFSFileShareDefaults nfsFileShareDefaults) Sets the value of the NFSFileShareDefaults property for this object.notificationPolicy
(String notificationPolicy) The notification policy of the file share.Sets the value of the ObjectACL property for this object.Sets the value of the ObjectACL property for this object.Sets the value of the Path property for this object.A value that sets the write status of a file share.requesterPays
(Boolean requesterPays) A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.Sets the value of the Role property for this object.Sets the value of the Squash property for this object.tags
(Collection<Tag> tags) A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name.tags
(Consumer<Tag.Builder>... tags) A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name.A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name.vpcEndpointDNSName
(String vpcEndpointDNSName) Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
gatewayARN
Sets the value of the GatewayARN property for this object.- Parameters:
gatewayARN
- The new value for the GatewayARN property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsEncrypted
Set to
true
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3. Optional.Valid Values:
true
|false
- Parameters:
kmsEncrypted
- Set totrue
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3. Optional.Valid Values:
true
|false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKey
Sets the value of the KMSKey property for this object.- Parameters:
kmsKey
- The new value for the KMSKey property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
path
Sets the value of the Path property for this object.- Parameters:
path
- The new value for the Path property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
role
Sets the value of the Role property for this object.- Parameters:
role
- The new value for the Role property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locationARN
Sets the value of the LocationARN property for this object.- Parameters:
locationARN
- The new value for the LocationARN property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_STANDARD
. Optional.Valid Values:
S3_STANDARD
|S3_INTELLIGENT_TIERING
|S3_STANDARD_IA
|S3_ONEZONE_IA
- Parameters:
defaultStorageClass
- The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value isS3_STANDARD
. Optional.Valid Values:
S3_STANDARD
|S3_INTELLIGENT_TIERING
|S3_STANDARD_IA
|S3_ONEZONE_IA
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectACL
Sets the value of the ObjectACL property for this object.- Parameters:
objectACL
- The new value for the ObjectACL property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectACL
Sets the value of the ObjectACL property for this object.- Parameters:
objectACL
- The new value for the ObjectACL property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientList
Sets the value of the ClientList property for this object.- Parameters:
clientList
- The new value for the ClientList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientList
Sets the value of the ClientList property for this object.- Parameters:
clientList
- The new value for the ClientList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
squash
Sets the value of the Squash property for this object.- Parameters:
squash
- The new value for the Squash property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readOnly
A value that sets the write status of a file share. Set this value to
true
to set the write status to read-only, otherwise set tofalse
.Valid Values:
true
|false
- Parameters:
readOnly
- A value that sets the write status of a file share. Set this value totrue
to set the write status to read-only, otherwise set tofalse
.Valid Values:
true
|false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
guessMIMETypeEnabled
A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to
true
to enable MIME type guessing, otherwise set tofalse
. The default value istrue
.Valid Values:
true
|false
- Parameters:
guessMIMETypeEnabled
- A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value totrue
to enable MIME type guessing, otherwise set tofalse
. The default value istrue
.Valid Values:
true
|false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requesterPays
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to
true
, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.RequesterPays
is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.Valid Values:
true
|false
- Parameters:
requesterPays
- A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set totrue
, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.RequesterPays
is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.Valid Values:
true
|false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.- Parameters:
tags
- A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using theListTagsForResource
API operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.- Parameters:
tags
- A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using theListTagsForResource
API operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
This is a convenience method that creates an instance of theListTagsForResource
API operation.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cacheAttributes
Refresh cache information for the file share.
- Parameters:
cacheAttributes
- Refresh cache information for the file share.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheAttributes
Refresh cache information for the file share.
This is a convenience method that creates an instance of theCacheAttributes.Builder
avoiding the need to create one manually viaCacheAttributes.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheAttributes(CacheAttributes)
.- Parameters:
cacheAttributes
- a consumer that will call methods onCacheAttributes.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
notificationPolicy
The notification policy of the file share.
SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a file before generating anObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.SettlingTimeInSeconds
has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.The following example sets
NotificationPolicy
on withSettlingTimeInSeconds
set to 60.{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets
NotificationPolicy
off.{}
- Parameters:
notificationPolicy
- The notification policy of the file share.SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time a client wrote to a file before generating anObjectUploaded
notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.SettlingTimeInSeconds
has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.The following example sets
NotificationPolicy
on withSettlingTimeInSeconds
set to 60.{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets
NotificationPolicy
off.{}
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcEndpointDNSName
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- Parameters:
vpcEndpointDNSName
- Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bucketRegion
Specifies the Region of the S3 bucket where the NFS file share stores files.
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- Parameters:
bucketRegion
- Specifies the Region of the S3 bucket where the NFS file share stores files.This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
- Parameters:
auditDestinationARN
- The Amazon Resource Name (ARN) of the storage used for audit logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.