@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateNFSFileShareRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateNFSFileShareInput
NOOP
Constructor and Description |
---|
CreateNFSFileShareRequest() |
Modifier and Type | Method and Description |
---|---|
CreateNFSFileShareRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAuditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
String |
getBucketRegion()
Specifies the Region of the S3 bucket where the NFS file share stores files.
|
CacheAttributes |
getCacheAttributes()
Specifies refresh cache information for the file share.
|
List<String> |
getClientList()
The list of clients that are allowed to access the S3 File Gateway.
|
String |
getClientToken()
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
String |
getDefaultStorageClass()
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
String |
getFileShareName()
The name of the file share.
|
String |
getGatewayARN()
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
|
Boolean |
getGuessMIMETypeEnabled()
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
Boolean |
getKMSEncrypted()
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. |
String |
getKMSKey()
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
String |
getLocationARN()
A custom ARN for the backend storage used for storing data for file shares.
|
NFSFileShareDefaults |
getNFSFileShareDefaults()
File share default values.
|
String |
getNotificationPolicy()
The notification policy of the file share.
|
String |
getObjectACL()
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway
puts objects into.
|
Boolean |
getReadOnly()
A value that sets the write status of a file share.
|
Boolean |
getRequesterPays()
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
String |
getRole()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
String |
getSquash()
A value that maps a user to anonymous user.
|
List<Tag> |
getTags()
A list of up to 50 tags that can be assigned to the NFS file share.
|
String |
getVPCEndpointDNSName()
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
|
int |
hashCode() |
Boolean |
isGuessMIMETypeEnabled()
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
Boolean |
isKMSEncrypted()
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. |
Boolean |
isReadOnly()
A value that sets the write status of a file share.
|
Boolean |
isRequesterPays()
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
void |
setAuditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
void |
setBucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the NFS file share stores files.
|
void |
setCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
|
void |
setClientList(Collection<String> clientList)
The list of clients that are allowed to access the S3 File Gateway.
|
void |
setClientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
void |
setDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
void |
setFileShareName(String fileShareName)
The name of the file share.
|
void |
setGatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
|
void |
setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
void |
setKMSEncrypted(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. |
void |
setKMSKey(String kMSKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
void |
setLocationARN(String locationARN)
A custom ARN for the backend storage used for storing data for file shares.
|
void |
setNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults)
File share default values.
|
void |
setNotificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
void |
setObjectACL(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.
|
void |
setReadOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
void |
setRequesterPays(Boolean requesterPays)
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
void |
setRole(String role)
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
void |
setSquash(String squash)
A value that maps a user to anonymous user.
|
void |
setTags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
void |
setVPCEndpointDNSName(String vPCEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
|
String |
toString()
Returns a string representation of this object.
|
CreateNFSFileShareRequest |
withAuditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
CreateNFSFileShareRequest |
withBucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the NFS file share stores files.
|
CreateNFSFileShareRequest |
withCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
|
CreateNFSFileShareRequest |
withClientList(Collection<String> clientList)
The list of clients that are allowed to access the S3 File Gateway.
|
CreateNFSFileShareRequest |
withClientList(String... clientList)
The list of clients that are allowed to access the S3 File Gateway.
|
CreateNFSFileShareRequest |
withClientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
CreateNFSFileShareRequest |
withDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
CreateNFSFileShareRequest |
withFileShareName(String fileShareName)
The name of the file share.
|
CreateNFSFileShareRequest |
withGatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
|
CreateNFSFileShareRequest |
withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
CreateNFSFileShareRequest |
withKMSEncrypted(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 |
withKMSKey(String kMSKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
CreateNFSFileShareRequest |
withLocationARN(String locationARN)
A custom ARN for the backend storage used for storing data for file shares.
|
CreateNFSFileShareRequest |
withNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults)
File share default values.
|
CreateNFSFileShareRequest |
withNotificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
CreateNFSFileShareRequest |
withObjectACL(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 |
withObjectACL(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 |
withReadOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
CreateNFSFileShareRequest |
withRequesterPays(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 |
withRole(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 |
withSquash(String squash)
A value that maps a user to anonymous user.
|
CreateNFSFileShareRequest |
withTags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateNFSFileShareRequest |
withTags(Tag... tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateNFSFileShareRequest |
withVPCEndpointDNSName(String vPCEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClientToken(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.public String getClientToken()
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
public CreateNFSFileShareRequest withClientToken(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.public void setNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults)
File share default values. Optional.
nFSFileShareDefaults
- File share default values. Optional.public NFSFileShareDefaults getNFSFileShareDefaults()
File share default values. Optional.
public CreateNFSFileShareRequest withNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults)
File share default values. Optional.
nFSFileShareDefaults
- File share default values. Optional.public void setGatewayARN(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.public String getGatewayARN()
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
public CreateNFSFileShareRequest withGatewayARN(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.public void setKMSEncrypted(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
public Boolean getKMSEncrypted()
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
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
public CreateNFSFileShareRequest withKMSEncrypted(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
public Boolean isKMSEncrypted()
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
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
public void setKMSKey(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.public String getKMSKey()
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.
KMSEncrypted
is true
. Optional.public CreateNFSFileShareRequest withKMSKey(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.public void setRole(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.public String getRole()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
public CreateNFSFileShareRequest withRole(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.public void setLocationARN(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
public String getLocationARN()
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
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
public CreateNFSFileShareRequest withLocationARN(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
public void setDefaultStorageClass(String 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
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
public String getDefaultStorageClass()
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
S3_STANDARD
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|
S3_STANDARD_IA
| S3_ONEZONE_IA
public CreateNFSFileShareRequest withDefaultStorageClass(String 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
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
public void setObjectACL(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
public String getObjectACL()
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
.
private
.ObjectACL
public CreateNFSFileShareRequest withObjectACL(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
public CreateNFSFileShareRequest withObjectACL(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
public List<String> getClientList()
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.
public void setClientList(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.public CreateNFSFileShareRequest withClientList(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.
NOTE: This method appends the values to the existing list (if any). Use
setClientList(java.util.Collection)
or withClientList(java.util.Collection)
if you want to
override the existing values.
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.public CreateNFSFileShareRequest withClientList(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.public void setSquash(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.
public String getSquash()
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.
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.
public CreateNFSFileShareRequest withSquash(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.
public void setReadOnly(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
public Boolean getReadOnly()
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
true
to set the write
status to read-only, otherwise set to false
.
Valid Values: true
| false
public CreateNFSFileShareRequest withReadOnly(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
public Boolean isReadOnly()
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
true
to set the write
status to read-only, otherwise set to false
.
Valid Values: true
| false
public void setGuessMIMETypeEnabled(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
public Boolean getGuessMIMETypeEnabled()
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
true
to enable MIME type guessing, otherwise set to false
. The default
value is true
.
Valid Values: true
| false
public CreateNFSFileShareRequest withGuessMIMETypeEnabled(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
public Boolean isGuessMIMETypeEnabled()
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
true
to enable MIME type guessing, otherwise set to false
. The default
value is true
.
Valid Values: true
| false
public void setRequesterPays(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
public Boolean getRequesterPays()
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
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
public CreateNFSFileShareRequest withRequesterPays(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
public Boolean isRequesterPays()
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
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
public List<Tag> getTags()
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.
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.
public void setTags(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.
public CreateNFSFileShareRequest withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.
public CreateNFSFileShareRequest withTags(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.
public void setFileShareName(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.
public String getFileShareName()
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
must be set if an S3 prefix name is set in LocationARN
, or if an
access point or access point alias is used.
public CreateNFSFileShareRequest withFileShareName(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.
public void setCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
cacheAttributes
- Specifies refresh cache information for the file share.public CacheAttributes getCacheAttributes()
Specifies refresh cache information for the file share.
public CreateNFSFileShareRequest withCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
cacheAttributes
- Specifies refresh cache information for the file share.public void setNotificationPolicy(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.
{}
public String getNotificationPolicy()
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.
{}
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.
{}
public CreateNFSFileShareRequest withNotificationPolicy(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.
{}
public void setVPCEndpointDNSName(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.
public String getVPCEndpointDNSName()
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.
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.
public CreateNFSFileShareRequest withVPCEndpointDNSName(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.
public void setBucketRegion(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.
public String getBucketRegion()
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.
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.
public CreateNFSFileShareRequest withBucketRegion(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.
public void setAuditDestinationARN(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.public String getAuditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
public CreateNFSFileShareRequest withAuditDestinationARN(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.public String toString()
toString
in class Object
Object.toString()
public CreateNFSFileShareRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()