Class CreateOntapVolumeConfiguration

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

Specifies the configuration of the ONTAP volume that you are creating.

See Also:

  • Method Details

    • junctionPath

      public final String 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

      public final SecurityStyle 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. 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 return SecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityStyleAsString().

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

      public final String 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. 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 return SecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityStyleAsString().

      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. 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 public final Integer sizeInMegabytes()
      Deprecated.
      This property is deprecated, use SizeInBytes instead

      Use 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

      public final Boolean 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 a RW volume ( OntapVolumeType set to RW).

      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 a RW volume ( OntapVolumeType set to RW).

    • storageVirtualMachineId

      public final String storageVirtualMachineId()

      Specifies the ONTAP SVM in which to create the volume.

      Returns:
      Specifies the ONTAP SVM in which to create the volume.

    • tieringPolicy

      public final TieringPolicy tieringPolicy()
      Returns the value of the TieringPolicy property for this object.
      Returns:
      The value of the TieringPolicy property for this object.

    • ontapVolumeType

      public final InputOntapVolumeType 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. A DP 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 return InputOntapVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ontapVolumeTypeAsString().

      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. A DP 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

      public final String 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. A DP 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 return InputOntapVolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ontapVolumeTypeAsString().

      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. A DP 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

      public final String 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 the default 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 the default 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

      public final Boolean 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

      public final CreateSnaplockConfiguration snaplockConfiguration()

      Specifies the SnapLock configuration for an FSx for ONTAP volume.

      Returns:
      Specifies the SnapLock configuration for an FSx for ONTAP volume.

    • volumeStyle

      public final VolumeStyle 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 return VolumeStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeStyleAsString().

      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

      public final String 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 return VolumeStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeStyleAsString().

      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

      public final CreateAggregateConfiguration 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

      public final Long sizeInBytes()

      Specifies the configured size of the volume, in bytes.

      Returns:
      Specifies the configured size of the volume, in bytes.

    • toBuilder

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

    • builder

      public static CreateOntapVolumeConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOntapVolumeConfiguration.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.