Interface NFSFileShareInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>, SdkBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>, SdkPojo
Enclosing class:
NFSFileShareInfo
@Mutable @NotThreadSafe public static interface NFSFileShareInfo.Builder extends SdkPojo, CopyableBuilder<NFSFileShareInfo.Builder,NFSFileShareInfo>

  • Method Details

    • nfsFileShareDefaults

      NFSFileShareInfo.Builder nfsFileShareDefaults(NFSFileShareDefaults nfsFileShareDefaults)
      Sets the value of the NFSFileShareDefaults property for this object.
      Parameters:
      nfsFileShareDefaults - The new value for the NFSFileShareDefaults property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nfsFileShareDefaults

      default NFSFileShareInfo.Builder nfsFileShareDefaults(Consumer<NFSFileShareDefaults.Builder> nfsFileShareDefaults)
      Sets the value of the NFSFileShareDefaults property for this object. This is a convenience method that creates an instance of the NFSFileShareDefaults.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).

      Parameters:
      nfsFileShareDefaults - a consumer that will call methods on NFSFileShareDefaults.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileShareARN

      NFSFileShareInfo.Builder fileShareARN(String fileShareARN)
      Sets the value of the FileShareARN property for this object.
      Parameters:
      fileShareARN - The new value for the FileShareARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileShareId

      NFSFileShareInfo.Builder fileShareId(String fileShareId)
      Sets the value of the FileShareId property for this object.
      Parameters:
      fileShareId - The new value for the FileShareId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileShareStatus

      NFSFileShareInfo.Builder fileShareStatus(String fileShareStatus)
      Sets the value of the FileShareStatus property for this object.
      Parameters:
      fileShareStatus - The new value for the FileShareStatus property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayARN

      NFSFileShareInfo.Builder gatewayARN(String gatewayARN)
      Sets the value of the GatewayARN property for this object.
      Parameters:
      gatewayARN - The new value for the GatewayARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionType

      NFSFileShareInfo.Builder encryptionType(String encryptionType)

      A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Parameters:
      encryptionType - A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionType

      NFSFileShareInfo.Builder encryptionType(EncryptionType encryptionType)

      A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Parameters:
      encryptionType - A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsEncrypted

      @Deprecated NFSFileShareInfo.Builder kmsEncrypted(Boolean kmsEncrypted)
      Deprecated.
      KMSEncrypted is deprecated, use EncryptionType instead.

      Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Valid Values: true | false

      Parameters:
      kmsEncrypted - Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.

      We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

      Valid Values: true | false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKey

      NFSFileShareInfo.Builder kmsKey(String kmsKey)
      Sets the value of the KMSKey property for this object.
      Parameters:
      kmsKey - The new value for the KMSKey property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      NFSFileShareInfo.Builder path(String path)
      Sets the value of the Path property for this object.
      Parameters:
      path - The new value for the Path property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • role

      NFSFileShareInfo.Builder role(String role)
      Sets the value of the Role property for this object.
      Parameters:
      role - The new value for the Role property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationARN

      NFSFileShareInfo.Builder locationARN(String locationARN)
      Sets the value of the LocationARN property for this object.
      Parameters:
      locationARN - The new value for the LocationARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultStorageClass

      NFSFileShareInfo.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_STANDARD. Optional.

      Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

      Parameters:
      defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

      Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objectACL

      NFSFileShareInfo.Builder objectACL(String objectACL)
      Sets the value of the ObjectACL property for this object.
      Parameters:
      objectACL - The new value for the ObjectACL property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectACL

      NFSFileShareInfo.Builder objectACL(ObjectACL objectACL)
      Sets the value of the ObjectACL property for this object.
      Parameters:
      objectACL - The new value for the ObjectACL property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientList

      NFSFileShareInfo.Builder clientList(Collection<String> clientList)
      Sets the value of the ClientList property for this object.
      Parameters:
      clientList - The new value for the ClientList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientList

      NFSFileShareInfo.Builder clientList(String... clientList)
      Sets the value of the ClientList property for this object.
      Parameters:
      clientList - The new value for the ClientList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • squash

      NFSFileShareInfo.Builder squash(String squash)
      Sets the value of the Squash property for this object.
      Parameters:
      squash - The new value for the Squash property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readOnly

      NFSFileShareInfo.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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • guessMIMETypeEnabled

      NFSFileShareInfo.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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • requesterPays

      NFSFileShareInfo.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

      Parameters:
      requesterPays - A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NFSFileShareInfo.Builder tags(Collection<Tag> tags)

      A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

      Parameters:
      tags - A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NFSFileShareInfo.Builder tags(Tag... tags)

      A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

      Parameters:
      tags - A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      NFSFileShareInfo.Builder tags(Consumer<Tag.Builder>... tags)

      A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileShareName

      NFSFileShareInfo.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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheAttributes

      NFSFileShareInfo.Builder cacheAttributes(CacheAttributes cacheAttributes)

      Refresh cache information for the file share.

      Parameters:
      cacheAttributes - Refresh cache information for the file share.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheAttributes

      default NFSFileShareInfo.Builder cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)

      Refresh cache information for the file share.

      This is a convenience method that creates an instance of the CacheAttributes.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).

      Parameters:
      cacheAttributes - a consumer that will call methods on CacheAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notificationPolicy

      NFSFileShareInfo.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.

      This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.

      The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

      {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

      The following example sets NotificationPolicy off.

      {}

      Parameters:
      notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating 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.

      This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.

      The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

      {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

      The following example sets NotificationPolicy off.

      {}

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcEndpointDNSName

      NFSFileShareInfo.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.

      Parameters:
      vpcEndpointDNSName - Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

      This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketRegion

      NFSFileShareInfo.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.

      Parameters:
      bucketRegion - Specifies the Region of the S3 bucket where the NFS file share stores files.

      This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • auditDestinationARN

      NFSFileShareInfo.Builder auditDestinationARN(String auditDestinationARN)

      The Amazon Resource Name (ARN) of the storage used for audit logs.

      Parameters:
      auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.