Class CreateOntapVolumeConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CreateOntapVolumeConfiguration.Builder,
CreateOntapVolumeConfiguration>
Specifies the configuration of the ONTAP volume that you are creating.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionUse to specify configuration options for a volume’s storage aggregate or aggregates.builder()
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 InputOntapVolumeType
Specifies the type of volume you are creating.final String
Specifies the type of volume you are creating.final SecurityStyle
Specifies the security style for the volume.final String
Specifies the security style for the volume.static Class
<? extends CreateOntapVolumeConfiguration.Builder> final Long
Specifies the configured size of the volume, in bytes.final Integer
Deprecated.This property is deprecated, use SizeInBytes insteadSpecifies the SnapLock configuration for an FSx for ONTAP volume.final String
Specifies the snapshot policy for the volume.final Boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.final String
Specifies the ONTAP SVM in which to create the volume.final TieringPolicy
Returns the value of the TieringPolicy property for this object.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.final VolumeStyle
Use to specify the style of an ONTAP volume.final String
Use to specify the style of an ONTAP volume.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. This parameter is required. 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. This parameter is required.
The
JunctionPath
must have a leading forward slash, such as/vol3
.
-
securityStyle
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
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:
- Specifies the security style for the volume. If a volume's security style is not specified, it is
automatically set to the root volume's security style. The security style determines the type of
permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style
in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
-
- See Also:
-
-
securityStyleAsString
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
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:
- Specifies the security style for the volume. If a volume's security style is not specified, it is
automatically set to the root volume's security style. The security style determines the type of
permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style
in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
-
- See Also:
-
-
sizeInMegabytes
Deprecated.This property is deprecated, use SizeInBytes insteadUse
SizeInBytes
instead. Specifies the size of the volume, in megabytes (MB), that you are creating.- Returns:
- Use
SizeInBytes
instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
-
storageEfficiencyEnabled
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
StorageEfficiencyEnabled
is required when creating aRW
volume (OntapVolumeType
set toRW
).- Returns:
- Set to true to enable deduplication, compression, and compaction storage efficiency features on the
volume, or set to false to disable them.
StorageEfficiencyEnabled
is required when creating aRW
volume (OntapVolumeType
set toRW
).
-
storageVirtualMachineId
Specifies the ONTAP SVM in which to create the volume.
- Returns:
- Specifies the ONTAP SVM in which to create the volume.
-
tieringPolicy
Returns the value of the TieringPolicy property for this object.- Returns:
- The value of the TieringPolicy property for this object.
-
ontapVolumeType
Specifies the type of volume you are creating. Valid values are the following:
-
RW
specifies a read/write volume.RW
is the default. -
DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
If the service returns an enum value that is not available in the current SDK version,
ontapVolumeType
will returnInputOntapVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromontapVolumeTypeAsString()
.- Returns:
- Specifies the type of volume you are creating. Valid values are the following:
-
RW
specifies a read/write volume.RW
is the default. -
DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
-
- See Also:
-
-
ontapVolumeTypeAsString
Specifies the type of volume you are creating. Valid values are the following:
-
RW
specifies a read/write volume.RW
is the default. -
DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
If the service returns an enum value that is not available in the current SDK version,
ontapVolumeType
will returnInputOntapVolumeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromontapVolumeTypeAsString()
.- Returns:
- Specifies the type of volume you are creating. Valid values are the following:
-
RW
specifies a read/write volume.RW
is the default. -
DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
-
- See Also:
-
-
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
Specifies the SnapLock configuration for an FSx for ONTAP volume.
- Returns:
- Specifies the SnapLock configuration for an FSx for ONTAP volume.
-
volumeStyle
Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
If the service returns an enum value that is not available in the current SDK version,
volumeStyle
will returnVolumeStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeStyleAsString()
.- Returns:
- Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
- See Also:
-
volumeStyleAsString
Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
If the service returns an enum value that is not available in the current SDK version,
volumeStyle
will returnVolumeStyle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvolumeStyleAsString()
.- Returns:
- Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
- See Also:
-
aggregateConfiguration
Use to specify configuration options for a volume’s storage aggregate or aggregates.
- Returns:
- Use to specify configuration options for a volume’s storage aggregate or aggregates.
-
sizeInBytes
Specifies the configured size of the volume, in bytes.
- Returns:
- Specifies 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<CreateOntapVolumeConfiguration.Builder,
CreateOntapVolumeConfiguration> - 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
-