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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
OpenZFSFileSystemConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Integer
automaticBackupRetentionDays()
Returns the value of the AutomaticBackupRetentionDays property for this object.static OpenZFSFileSystemConfiguration.Builder
builder()
Boolean
copyTagsToBackups()
A Boolean value indicating whether tags on the file system should be copied to backups.Boolean
copyTagsToVolumes()
A Boolean value indicating whether tags for the volume should be copied to snapshots.String
dailyAutomaticBackupStartTime()
Returns the value of the DailyAutomaticBackupStartTime property for this object.OpenZFSDeploymentType
deploymentType()
Specifies the file-system deployment type.String
deploymentTypeAsString()
Specifies the file-system deployment type.DiskIopsConfiguration
diskIopsConfiguration()
Returns the value of the DiskIopsConfiguration property for this object.String
endpointIpAddress()
The IP address of the endpoint that is used to access data or to manage the file system.String
endpointIpAddressRange()
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasRouteTableIds()
For responses, this returns true if the service returned a value for the RouteTableIds property.String
preferredSubnetId()
Required whenDeploymentType
is set toMULTI_AZ_1
.String
rootVolumeId()
The ID of the root volume of the OpenZFS file system.List<String>
routeTableIds()
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.List<SdkField<?>>
sdkFields()
static Class<? extends OpenZFSFileSystemConfiguration.Builder>
serializableBuilderClass()
Integer
throughputCapacity()
The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).OpenZFSFileSystemConfiguration.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
weeklyMaintenanceStartTime()
Returns the value of the WeeklyMaintenanceStartTime property for this object.-
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
-
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 istrue
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 istrue
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 totrue
, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value istrue
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 totrue
, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value istrue
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_1
, andSINGLE_AZ_2
.If the service returns an enum value that is not available in the current SDK version,
deploymentType
will returnOpenZFSDeploymentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentTypeAsString()
.- Returns:
- Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
MULTI_AZ_1
,SINGLE_AZ_1
, andSINGLE_AZ_2
. - See Also:
OpenZFSDeploymentType
-
deploymentTypeAsString
public final String deploymentTypeAsString()
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
MULTI_AZ_1
,SINGLE_AZ_1
, andSINGLE_AZ_2
.If the service returns an enum value that is not available in the current SDK version,
deploymentType
will returnOpenZFSDeploymentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentTypeAsString()
.- Returns:
- Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
MULTI_AZ_1
,SINGLE_AZ_1
, andSINGLE_AZ_2
. - See Also:
OpenZFSDeploymentType
-
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 toMULTI_AZ_1
. This specifies the subnet in which you want the preferred file server to be located.- Returns:
- Required when
DeploymentType
is set toMULTI_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 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.
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>
-
builder
public static OpenZFSFileSystemConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends OpenZFSFileSystemConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-