software.amazon.awssdk.services.storagegateway.model

Class CreateNfsFileShareRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.CreateNfsFileShareRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateNfsFileShareRequest
extends StorageGatewayRequest
implements ToCopyableBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>

CreateNFSFileShareInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNfsFileShareRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateNfsFileShareRequest.Builder	builder()
CacheAttributes	cacheAttributes() Refresh cache information.
List<String>	clientList() The list of clients that are allowed to access the file gateway.
String	clientToken() A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
String	defaultStorageClass() The default storage class for objects put into an Amazon S3 bucket by the file gateway.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileShareName() The name of the file share.
String	gatewayARN() The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Boolean	guessMIMETypeEnabled() A value that enables guessing of the MIME type for uploaded objects based on file extensions.
boolean	hasClientList() Returns true if the ClientList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Boolean	kmsEncrypted() Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
String	kmsKey() The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
String	locationARN() The ARN of the backend storage used for storing file data.
NFSFileShareDefaults	nfsFileShareDefaults() File share default values.
String	notificationPolicy() The notification policy of the file share.
ObjectACL	objectACL() A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into.
String	objectACLAsString() A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into.
Boolean	readOnly() A value that sets the write status of a file share.
Boolean	requesterPays() A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
String	role() The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateNfsFileShareRequest.Builder>	serializableBuilderClass()
String	squash() A value that maps a user to anonymous user.
List<Tag>	tags() A list of up to 50 tags that can be assigned to the NFS file share.
CreateNfsFileShareRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientToken

public final String clientToken()

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Returns:

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

nfsFileShareDefaults

public final NFSFileShareDefaults nfsFileShareDefaults()

File share default values. Optional.

Returns:

File share default values. Optional.

gatewayARN

public final String gatewayARN()

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Returns:

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

kmsEncrypted

public final Boolean kmsEncrypted()

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false 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 AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

kmsKey

public final 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.

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 is true. Optional.

role

public final String role()

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Returns:

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

locationARN

public final String locationARN()

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Returns:

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

defaultStorageClass

public final String defaultStorageClass()

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. 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 file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

objectACL

public final ObjectACL objectACL()

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a 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 return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectACLAsString().

Returns:

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

See Also:

ObjectACL

objectACLAsString

public final String objectACLAsString()

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a 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 return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectACLAsString().

Returns:

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

See Also:

ObjectACL

hasClientList

public final boolean hasClientList()

Returns true if the ClientList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

clientList

public final List<String> clientList()

The list of clients that are allowed to access the 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.

You can use hasClientList() to see if a value was sent in this field.

Returns:

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

squash

public final 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.

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

public final 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

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 to false.

Valid Values: true | false

guessMIMETypeEnabled

public final 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

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 to false. The default value is true.

Valid Values: true | false

requesterPays

public final 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

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()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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.

fileShareName

public final String fileShareName()

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

Returns:

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

cacheAttributes

public final CacheAttributes cacheAttributes()

Refresh cache information.

Returns:

Refresh cache information.

notificationPolicy

public final String notificationPolicy()

The notification policy of the file share.

Returns:

The notification policy of the file share.

toBuilder

public CreateNfsFileShareRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static CreateNfsFileShareRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateNfsFileShareRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo