Class CreateNfsFileShareRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateNfsFileShareRequest.Builder,
CreateNfsFileShareRequest>
CreateNFSFileShareInput
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) of the storage used for audit logs.final String
Specifies the Region of the S3 bucket where the NFS file share stores files.builder()
final CacheAttributes
Specifies refresh cache information for the file share.The list of clients that are allowed to access the S3 File Gateway.final String
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.final String
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the file share.final String
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final Boolean
A value that enables guessing of the MIME type for uploaded objects based on file extensions.final boolean
For responses, this returns true if the service returned a value for the ClientList property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Set totrue
to use Amazon S3 server-side encryption with your own KMS key, orfalse
to use a key managed by Amazon S3.final String
kmsKey()
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.final String
A custom ARN for the backend storage used for storing data for file shares.final NFSFileShareDefaults
File share default values.final String
The notification policy of the file share.final 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.final String
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into.final Boolean
readOnly()
A value that sets the write status of a file share.final Boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.final String
role()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.static Class
<? extends CreateNfsFileShareRequest.Builder> final String
squash()
A value that maps a user to anonymous user.tags()
A list of up to 50 tags that can be assigned to the NFS file share.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientToken
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
- Returns:
- A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
-
gatewayARN
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
- Returns:
- The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
-
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
- Returns:
- 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
-
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
istrue
. Optional.- Returns:
- 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
istrue
. Optional.
-
role
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
- Returns:
- The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
-
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
- Returns:
- 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
-
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
- Returns:
- 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
-
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
.If the service returns an enum value that is not available in the current SDK version,
objectACL
will returnObjectACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectACLAsString()
.- Returns:
- 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
. - See Also:
-
objectACLAsString
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
.If the service returns an enum value that is not available in the current SDK version,
objectACL
will returnObjectACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectACLAsString()
.- Returns:
- 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
. - See Also:
-
hasClientList
public final boolean hasClientList()For responses, this returns true if the service returned a value for the ClientList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasClientList()
method.- Returns:
- 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.
-
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.
- Returns:
- 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.
-
-
-
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
- Returns:
- 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
-
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
- Returns:
- 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
-
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
- Returns:
- 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
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- 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.
-
cacheAttributes
Specifies refresh cache information for the file share.
- Returns:
- Specifies refresh cache information for the file share.
-
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:
- 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.{}
-
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:
- 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.
-
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:
- 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.
-
auditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
- Returns:
- The Amazon Resource Name (ARN) of the storage used for audit logs.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateNfsFileShareRequest.Builder,
CreateNfsFileShareRequest> - Specified by:
toBuilder
in classStorageGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-