Class UpdateOntapVolumeConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UpdateOntapVolumeConfiguration.Builder,
UpdateOntapVolumeConfiguration>
Used to specify changes to the ONTAP configuration for the volume you are updating.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
A boolean flag indicating whether tags for the volume should be copied to backups.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
Specifies the location in the SVM's namespace where the volume is mounted.final SecurityStyle
The security style for the volume, which can beUNIX
,NTFS
, orMIXED
.final String
The security style for the volume, which can beUNIX
,NTFS
, orMIXED
.static Class
<? extends UpdateOntapVolumeConfiguration.Builder> final Long
The configured size of the volume, in bytes.final Integer
Specifies the size of the volume in megabytes.The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.final String
Specifies the snapshot policy for the volume.final Boolean
Default isfalse
.final TieringPolicy
Update the volume's data tiering policy.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
junctionPath
Specifies the location in the SVM's namespace where the volume is mounted. The
JunctionPath
must have a leading forward slash, such as/vol3
.- Returns:
- Specifies the location in the SVM's namespace where the volume is mounted. The
JunctionPath
must have a leading forward slash, such as/vol3
.
-
securityStyle
The security style for the volume, which can be
UNIX
,NTFS
, orMIXED
.If the service returns an enum value that is not available in the current SDK version,
securityStyle
will returnSecurityStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityStyleAsString()
.- Returns:
- The security style for the volume, which can be
UNIX
,NTFS
, orMIXED
. - See Also:
-
securityStyleAsString
The security style for the volume, which can be
UNIX
,NTFS
, orMIXED
.If the service returns an enum value that is not available in the current SDK version,
securityStyle
will returnSecurityStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityStyleAsString()
.- Returns:
- The security style for the volume, which can be
UNIX
,NTFS
, orMIXED
. - See Also:
-
sizeInMegabytes
Specifies the size of the volume in megabytes.
- Returns:
- Specifies the size of the volume in megabytes.
-
storageEfficiencyEnabled
Default is
false
. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.- Returns:
- Default is
false
. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
-
tieringPolicy
Update the volume's data tiering policy.
- Returns:
- Update the volume's data tiering policy.
-
snapshotPolicy
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
-
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. -
default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule. -
none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
- Returns:
- Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
-
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. -
default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule. -
none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
-
-
-
copyTagsToBackups
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
- Returns:
- A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
-
snaplockConfiguration
The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
- Returns:
- The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
-
sizeInBytes
The configured size of the volume, in bytes.
- Returns:
- The configured size of the volume, in bytes.
-
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<UpdateOntapVolumeConfiguration.Builder,
UpdateOntapVolumeConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-