public static interface CreateNfsFileShareRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateNfsFileShareRequest.Builder |
auditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
CreateNfsFileShareRequest.Builder |
bucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the NFS file share stores files.
|
CreateNfsFileShareRequest.Builder |
cacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
|
default CreateNfsFileShareRequest.Builder |
cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
Specifies refresh cache information for the file share.
|
CreateNfsFileShareRequest.Builder |
clientList(Collection<String> clientList)
The list of clients that are allowed to access the S3 File Gateway.
|
CreateNfsFileShareRequest.Builder |
clientList(String... clientList)
The list of clients that are allowed to access the S3 File Gateway.
|
CreateNfsFileShareRequest.Builder |
clientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share
creation.
|
CreateNfsFileShareRequest.Builder |
defaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
CreateNfsFileShareRequest.Builder |
fileShareName(String fileShareName)
The name of the file share.
|
CreateNfsFileShareRequest.Builder |
gatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
|
CreateNfsFileShareRequest.Builder |
guessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
CreateNfsFileShareRequest.Builder |
kmsEncrypted(Boolean kmsEncrypted)
Set to
true to use Amazon S3 server-side encryption with your own KMS key, or false
to use a key managed by Amazon S3. |
CreateNfsFileShareRequest.Builder |
kmsKey(String kmsKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
CreateNfsFileShareRequest.Builder |
locationARN(String locationARN)
A custom ARN for the backend storage used for storing data for file shares.
|
default CreateNfsFileShareRequest.Builder |
nfsFileShareDefaults(Consumer<NFSFileShareDefaults.Builder> nfsFileShareDefaults)
File share default values.
|
CreateNfsFileShareRequest.Builder |
nfsFileShareDefaults(NFSFileShareDefaults nfsFileShareDefaults)
File share default values.
|
CreateNfsFileShareRequest.Builder |
notificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
CreateNfsFileShareRequest.Builder |
objectACL(ObjectACL objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into.
|
CreateNfsFileShareRequest.Builder |
objectACL(String objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into.
|
CreateNfsFileShareRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateNfsFileShareRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateNfsFileShareRequest.Builder |
readOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
CreateNfsFileShareRequest.Builder |
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.
|
CreateNfsFileShareRequest.Builder |
role(String role)
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
CreateNfsFileShareRequest.Builder |
squash(String squash)
A value that maps a user to anonymous user.
|
CreateNfsFileShareRequest.Builder |
tags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateNfsFileShareRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateNfsFileShareRequest.Builder |
tags(Tag... tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateNfsFileShareRequest.Builder |
vpcEndpointDNSName(String vpcEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateNfsFileShareRequest.Builder clientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
clientToken - A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share
creation.CreateNfsFileShareRequest.Builder nfsFileShareDefaults(NFSFileShareDefaults nfsFileShareDefaults)
File share default values. Optional.
nfsFileShareDefaults - File share default values. Optional.default CreateNfsFileShareRequest.Builder nfsFileShareDefaults(Consumer<NFSFileShareDefaults.Builder> nfsFileShareDefaults)
File share default values. Optional.
This is a convenience that creates an instance of theNFSFileShareDefaults.Builder avoiding the need
to create one manually via NFSFileShareDefaults.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to nfsFileShareDefaults(NFSFileShareDefaults).nfsFileShareDefaults - a consumer that will call methods on NFSFileShareDefaults.BuildernfsFileShareDefaults(NFSFileShareDefaults)CreateNfsFileShareRequest.Builder gatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
gatewayARN - The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.CreateNfsFileShareRequest.Builder kmsEncrypted(Boolean kmsEncrypted)
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true | false
kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or
false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
CreateNfsFileShareRequest.Builder kmsKey(String kmsKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when
KMSEncrypted is true. Optional.
kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when
KMSEncrypted is true. Optional.CreateNfsFileShareRequest.Builder role(String role)
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
role - The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it
accesses the underlying storage.CreateNfsFileShareRequest.Builder locationARN(String locationARN)
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
locationARN - A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN
with an optional prefix concatenation. The prefix must end with a forward slash (/). You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
CreateNfsFileShareRequest.Builder defaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value
is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default
value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
CreateNfsFileShareRequest.Builder objectACL(String objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.
objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.ObjectACL,
ObjectACLCreateNfsFileShareRequest.Builder objectACL(ObjectACL objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.
objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.ObjectACL,
ObjectACLCreateNfsFileShareRequest.Builder clientList(Collection<String> clientList)
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
clientList - The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid
IP addresses or valid CIDR blocks.CreateNfsFileShareRequest.Builder clientList(String... clientList)
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
clientList - The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid
IP addresses or valid CIDR blocks.CreateNfsFileShareRequest.Builder squash(String squash)
A value that maps a user to anonymous user.
Valid values are the following:
RootSquash: Only root is mapped to anonymous user.
NoSquash: No one is mapped to anonymous user.
AllSquash: Everyone is mapped to anonymous user.
squash - A value that maps a user to anonymous user.
Valid values are the following:
RootSquash: Only root is mapped to anonymous user.
NoSquash: No one is mapped to anonymous user.
AllSquash: Everyone is mapped to anonymous user.
CreateNfsFileShareRequest.Builder readOnly(Boolean 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 to false.
Valid Values: true | false
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 to false.
Valid Values: true | false
CreateNfsFileShareRequest.Builder guessMIMETypeEnabled(Boolean 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 to false. The default value is
true.
Valid Values: true | false
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 to false. The
default value is true.
Valid Values: true | false
CreateNfsFileShareRequest.Builder 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. 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
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
CreateNfsFileShareRequest.Builder tags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
CreateNfsFileShareRequest.Builder tags(Tag... tags)
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
CreateNfsFileShareRequest.Builder tags(Consumer<Tag.Builder>... tags)
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateNfsFileShareRequest.Builder fileShareName(String fileShareName)
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an
access point or access point alias is used.
fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if
an access point or access point alias is used.
CreateNfsFileShareRequest.Builder cacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
cacheAttributes - Specifies refresh cache information for the file share.default CreateNfsFileShareRequest.Builder cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
Specifies refresh cache information for the file share.
This is a convenience that creates an instance of theCacheAttributes.Builder avoiding the need to
create one manually via CacheAttributes.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to cacheAttributes(CacheAttributes).cacheAttributes - a consumer that will call methods on CacheAttributes.BuildercacheAttributes(CacheAttributes)CreateNfsFileShareRequest.Builder notificationPolicy(String 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 an
ObjectUploaded 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 with SettlingTimeInSeconds set to
60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
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 an
ObjectUploaded 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 with SettlingTimeInSeconds
set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
CreateNfsFileShareRequest.Builder vpcEndpointDNSName(String 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.
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.
CreateNfsFileShareRequest.Builder bucketRegion(String 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.
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.
CreateNfsFileShareRequest.Builder auditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.CreateNfsFileShareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateNfsFileShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.