Class OpenZFSFileSystemConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.OpenZFSFileSystemConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OpenZFSFileSystemConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>

The configuration for the Amazon FSx for OpenZFS file system.

See Also:

  • Method Details

    • automaticBackupRetentionDays

      public final Integer automaticBackupRetentionDays()
      Returns the value of the AutomaticBackupRetentionDays property for this object.
      Returns:
      The value of the AutomaticBackupRetentionDays property for this object.

    • copyTagsToBackups

      public final Boolean copyTagsToBackups()

      A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

      Returns:
      A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

    • copyTagsToVolumes

      public final Boolean copyTagsToVolumes()

      A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

      Returns:
      A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

    • dailyAutomaticBackupStartTime

      public final String dailyAutomaticBackupStartTime()
      Returns the value of the DailyAutomaticBackupStartTime property for this object.
      Returns:
      The value of the DailyAutomaticBackupStartTime property for this object.

    • deploymentType

      public final OpenZFSDeploymentType deploymentType()

      Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return OpenZFSDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

      Returns:
      Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return OpenZFSDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

      Returns:
      Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.
      See Also:

    • throughputCapacity

      public final Integer throughputCapacity()

      The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

      Returns:
      The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

    • weeklyMaintenanceStartTime

      public final String weeklyMaintenanceStartTime()
      Returns the value of the WeeklyMaintenanceStartTime property for this object.
      Returns:
      The value of the WeeklyMaintenanceStartTime property for this object.

    • diskIopsConfiguration

      public final DiskIopsConfiguration diskIopsConfiguration()
      Returns the value of the DiskIopsConfiguration property for this object.
      Returns:
      The value of the DiskIopsConfiguration property for this object.

    • rootVolumeId

      public final String rootVolumeId()

      The ID of the root volume of the OpenZFS file system.

      Returns:
      The ID of the root volume of the OpenZFS file system.

    • preferredSubnetId

      public final String preferredSubnetId()

      Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

      Returns:
      Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

    • endpointIpAddressRange

      public final String endpointIpAddressRange()

      (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

      Returns:
      (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

    • hasRouteTableIds

      public final boolean hasRouteTableIds()
      For responses, this returns true if the service returned a value for the RouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • routeTableIds

      public final List<String> routeTableIds()

      (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

      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 hasRouteTableIds() method.

      Returns:
      (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

    • endpointIpAddress

      public final String endpointIpAddress()

      The IP address of the endpoint that is used to access data or to manage the file system.

      Returns:
      The IP address of the endpoint that is used to access data or to manage the file system.

    • toBuilder

      public OpenZFSFileSystemConfiguration.Builder 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 interface ToCopyableBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OpenZFSFileSystemConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.