CreateOntapVolumeConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.CreateOntapVolumeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateOntapVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the configuration of the ONTAP volume that you are creating.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateOntapVolumeConfiguration()

Constructors
Constructor and Description
`CreateOntapVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CreateOntapVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`CreateAggregateConfiguration`	`getAggregateConfiguration()` Use to specify configuration options for a volume’s storage aggregate or aggregates.
`Boolean`	`getCopyTagsToBackups()` A boolean flag indicating whether tags for the volume should be copied to backups.
`String`	`getJunctionPath()` Specifies the location in the SVM's namespace where the volume is mounted.
`String`	`getOntapVolumeType()` Specifies the type of volume you are creating.
`String`	`getSecurityStyle()` Specifies the security style for the volume.
`Long`	`getSizeInBytes()` Specifies the configured size of the volume, in bytes.
`Integer`	`getSizeInMegabytes()` Deprecated.
`CreateSnaplockConfiguration`	`getSnaplockConfiguration()` Specifies the SnapLock configuration for an FSx for ONTAP volume.
`String`	`getSnapshotPolicy()` Specifies the snapshot policy for the volume.
`Boolean`	`getStorageEfficiencyEnabled()` Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
`String`	`getStorageVirtualMachineId()` Specifies the ONTAP SVM in which to create the volume.
`TieringPolicy`	`getTieringPolicy()`
`String`	`getVolumeStyle()` Use to specify the style of an ONTAP volume.
`int`	`hashCode()`
`Boolean`	`isCopyTagsToBackups()` A boolean flag indicating whether tags for the volume should be copied to backups.
`Boolean`	`isStorageEfficiencyEnabled()` Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAggregateConfiguration(CreateAggregateConfiguration aggregateConfiguration)` Use to specify configuration options for a volume’s storage aggregate or aggregates.
`void`	`setCopyTagsToBackups(Boolean copyTagsToBackups)` A boolean flag indicating whether tags for the volume should be copied to backups.
`void`	`setJunctionPath(String junctionPath)` Specifies the location in the SVM's namespace where the volume is mounted.
`void`	`setOntapVolumeType(String ontapVolumeType)` Specifies the type of volume you are creating.
`void`	`setSecurityStyle(String securityStyle)` Specifies the security style for the volume.
`void`	`setSizeInBytes(Long sizeInBytes)` Specifies the configured size of the volume, in bytes.
`void`	`setSizeInMegabytes(Integer sizeInMegabytes)` Deprecated.
`void`	`setSnaplockConfiguration(CreateSnaplockConfiguration snaplockConfiguration)` Specifies the SnapLock configuration for an FSx for ONTAP volume.
`void`	`setSnapshotPolicy(String snapshotPolicy)` Specifies the snapshot policy for the volume.
`void`	`setStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)` Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
`void`	`setStorageVirtualMachineId(String storageVirtualMachineId)` Specifies the ONTAP SVM in which to create the volume.
`void`	`setTieringPolicy(TieringPolicy tieringPolicy)`
`void`	`setVolumeStyle(String volumeStyle)` Use to specify the style of an ONTAP volume.
`String`	`toString()` Returns a string representation of this object.
`CreateOntapVolumeConfiguration`	`withAggregateConfiguration(CreateAggregateConfiguration aggregateConfiguration)` Use to specify configuration options for a volume’s storage aggregate or aggregates.
`CreateOntapVolumeConfiguration`	`withCopyTagsToBackups(Boolean copyTagsToBackups)` A boolean flag indicating whether tags for the volume should be copied to backups.
`CreateOntapVolumeConfiguration`	`withJunctionPath(String junctionPath)` Specifies the location in the SVM's namespace where the volume is mounted.
`CreateOntapVolumeConfiguration`	`withOntapVolumeType(InputOntapVolumeType ontapVolumeType)` Specifies the type of volume you are creating.
`CreateOntapVolumeConfiguration`	`withOntapVolumeType(String ontapVolumeType)` Specifies the type of volume you are creating.
`CreateOntapVolumeConfiguration`	`withSecurityStyle(SecurityStyle securityStyle)` Specifies the security style for the volume.
`CreateOntapVolumeConfiguration`	`withSecurityStyle(String securityStyle)` Specifies the security style for the volume.
`CreateOntapVolumeConfiguration`	`withSizeInBytes(Long sizeInBytes)` Specifies the configured size of the volume, in bytes.
`CreateOntapVolumeConfiguration`	`withSizeInMegabytes(Integer sizeInMegabytes)` Deprecated.
`CreateOntapVolumeConfiguration`	`withSnaplockConfiguration(CreateSnaplockConfiguration snaplockConfiguration)` Specifies the SnapLock configuration for an FSx for ONTAP volume.
`CreateOntapVolumeConfiguration`	`withSnapshotPolicy(String snapshotPolicy)` Specifies the snapshot policy for the volume.
`CreateOntapVolumeConfiguration`	`withStorageEfficiencyEnabled(Boolean storageEfficiencyEnabled)` Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
`CreateOntapVolumeConfiguration`	`withStorageVirtualMachineId(String storageVirtualMachineId)` Specifies the ONTAP SVM in which to create the volume.
`CreateOntapVolumeConfiguration`	`withTieringPolicy(TieringPolicy tieringPolicy)`
`CreateOntapVolumeConfiguration`	`withVolumeStyle(String volumeStyle)` Use to specify the style of an ONTAP volume.
`CreateOntapVolumeConfiguration`	`withVolumeStyle(VolumeStyle volumeStyle)` Use to specify the style of an ONTAP volume.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateOntapVolumeConfiguration
```
public CreateOntapVolumeConfiguration()
```
- Method Detail
  - setJunctionPath
```
public void setJunctionPath(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.
    
    Parameters:
    
    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.
  - getJunctionPath
```
public String getJunctionPath()
```
    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.
  - withJunctionPath
```
public CreateOntapVolumeConfiguration withJunctionPath(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityStyle
```
public void setSecurityStyle(String 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.
    Parameters:
    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.
    See Also:
    
    SecurityStyle
  - getSecurityStyle
```
public String getSecurityStyle()
```
    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.
    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:
    
    SecurityStyle
  - withSecurityStyle
```
public CreateOntapVolumeConfiguration withSecurityStyle(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityStyle
  - withSecurityStyle
```
public CreateOntapVolumeConfiguration withSecurityStyle(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecurityStyle
  - setSizeInMegabytes
```
@Deprecated
public void setSizeInMegabytes(Integer sizeInMegabytes)
```
    Deprecated.
    
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    
    Parameters:
    
    sizeInMegabytes - Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
  - getSizeInMegabytes
```
@Deprecated
public Integer getSizeInMegabytes()
```
    Deprecated.
    
    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.
  - withSizeInMegabytes
```
@Deprecated
public CreateOntapVolumeConfiguration withSizeInMegabytes(Integer sizeInMegabytes)
```
    Deprecated.
    
    Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    
    Parameters:
    
    sizeInMegabytes - Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageEfficiencyEnabled
```
public void setStorageEfficiencyEnabled(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).
    
    Parameters:
    
    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).
  - getStorageEfficiencyEnabled
```
public Boolean getStorageEfficiencyEnabled()
```
    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).
  - withStorageEfficiencyEnabled
```
public CreateOntapVolumeConfiguration withStorageEfficiencyEnabled(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStorageEfficiencyEnabled
```
public Boolean isStorageEfficiencyEnabled()
```
    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).
  - setStorageVirtualMachineId
```
public void setStorageVirtualMachineId(String storageVirtualMachineId)
```
    Specifies the ONTAP SVM in which to create the volume.
    
    Parameters:
    
    storageVirtualMachineId - Specifies the ONTAP SVM in which to create the volume.
  - getStorageVirtualMachineId
```
public String getStorageVirtualMachineId()
```
    Specifies the ONTAP SVM in which to create the volume.
    
    Returns:
    
    Specifies the ONTAP SVM in which to create the volume.
  - withStorageVirtualMachineId
```
public CreateOntapVolumeConfiguration withStorageVirtualMachineId(String storageVirtualMachineId)
```
    Specifies the ONTAP SVM in which to create the volume.
    
    Parameters:
    
    storageVirtualMachineId - Specifies the ONTAP SVM in which to create the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTieringPolicy
```
public void setTieringPolicy(TieringPolicy tieringPolicy)
```
    Parameters:
    
    tieringPolicy -
  - getTieringPolicy
```
public TieringPolicy getTieringPolicy()
```
    Returns:
  - withTieringPolicy
```
public CreateOntapVolumeConfiguration withTieringPolicy(TieringPolicy tieringPolicy)
```
    Parameters:
    
    tieringPolicy -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOntapVolumeType
```
public void setOntapVolumeType(String 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.
    Parameters:
    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.
    See Also:
    
    InputOntapVolumeType
  - getOntapVolumeType
```
public String getOntapVolumeType()
```
    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.
    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:
    
    InputOntapVolumeType
  - withOntapVolumeType
```
public CreateOntapVolumeConfiguration withOntapVolumeType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InputOntapVolumeType
  - withOntapVolumeType
```
public CreateOntapVolumeConfiguration withOntapVolumeType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InputOntapVolumeType
  - setSnapshotPolicy
```
public void setSnapshotPolicy(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.
    Parameters:
    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.
  - getSnapshotPolicy
```
public String getSnapshotPolicy()
```
    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.
  - withSnapshotPolicy
```
public CreateOntapVolumeConfiguration withSnapshotPolicy(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCopyTagsToBackups
```
public void setCopyTagsToBackups(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.
    
    Parameters:
    
    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.
  - getCopyTagsToBackups
```
public Boolean getCopyTagsToBackups()
```
    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.
  - withCopyTagsToBackups
```
public CreateOntapVolumeConfiguration withCopyTagsToBackups(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCopyTagsToBackups
```
public Boolean isCopyTagsToBackups()
```
    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.
  - setSnaplockConfiguration
```
public void setSnaplockConfiguration(CreateSnaplockConfiguration snaplockConfiguration)
```
    Specifies the SnapLock configuration for an FSx for ONTAP volume.
    
    Parameters:
    
    snaplockConfiguration - Specifies the SnapLock configuration for an FSx for ONTAP volume.
  - getSnaplockConfiguration
```
public CreateSnaplockConfiguration getSnaplockConfiguration()
```
    Specifies the SnapLock configuration for an FSx for ONTAP volume.
    
    Returns:
    
    Specifies the SnapLock configuration for an FSx for ONTAP volume.
  - withSnaplockConfiguration
```
public CreateOntapVolumeConfiguration withSnaplockConfiguration(CreateSnaplockConfiguration snaplockConfiguration)
```
    Specifies the SnapLock configuration for an FSx for ONTAP volume.
    
    Parameters:
    
    snaplockConfiguration - Specifies the SnapLock configuration for an FSx for ONTAP volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeStyle
```
public void setVolumeStyle(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    VolumeStyle
  - getVolumeStyle
```
public String getVolumeStyle()
```
    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.
    
    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:
    
    VolumeStyle
  - withVolumeStyle
```
public CreateOntapVolumeConfiguration withVolumeStyle(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeStyle
  - withVolumeStyle
```
public CreateOntapVolumeConfiguration withVolumeStyle(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VolumeStyle
  - setAggregateConfiguration
```
public void setAggregateConfiguration(CreateAggregateConfiguration aggregateConfiguration)
```
    Use to specify configuration options for a volume’s storage aggregate or aggregates.
    
    Parameters:
    
    aggregateConfiguration - Use to specify configuration options for a volume’s storage aggregate or aggregates.
  - getAggregateConfiguration
```
public CreateAggregateConfiguration getAggregateConfiguration()
```
    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.
  - withAggregateConfiguration
```
public CreateOntapVolumeConfiguration withAggregateConfiguration(CreateAggregateConfiguration aggregateConfiguration)
```
    Use to specify configuration options for a volume’s storage aggregate or aggregates.
    
    Parameters:
    
    aggregateConfiguration - Use to specify configuration options for a volume’s storage aggregate or aggregates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSizeInBytes
```
public void setSizeInBytes(Long sizeInBytes)
```
    Specifies the configured size of the volume, in bytes.
    
    Parameters:
    
    sizeInBytes - Specifies the configured size of the volume, in bytes.
  - getSizeInBytes
```
public Long getSizeInBytes()
```
    Specifies the configured size of the volume, in bytes.
    
    Returns:
    
    Specifies the configured size of the volume, in bytes.
  - withSizeInBytes
```
public CreateOntapVolumeConfiguration withSizeInBytes(Long sizeInBytes)
```
    Specifies the configured size of the volume, in bytes.
    
    Parameters:
    
    sizeInBytes - Specifies the configured size of the volume, in bytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateOntapVolumeConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class CreateOntapVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateOntapVolumeConfiguration

Method Detail

setJunctionPath

getJunctionPath

withJunctionPath

setSecurityStyle

getSecurityStyle

withSecurityStyle

withSecurityStyle

setSizeInMegabytes

getSizeInMegabytes

withSizeInMegabytes

setStorageEfficiencyEnabled

getStorageEfficiencyEnabled

withStorageEfficiencyEnabled

isStorageEfficiencyEnabled

setStorageVirtualMachineId

getStorageVirtualMachineId

withStorageVirtualMachineId

setTieringPolicy

getTieringPolicy

withTieringPolicy

setOntapVolumeType

getOntapVolumeType

withOntapVolumeType

withOntapVolumeType

setSnapshotPolicy

getSnapshotPolicy

withSnapshotPolicy

setCopyTagsToBackups

getCopyTagsToBackups

withCopyTagsToBackups

isCopyTagsToBackups

setSnaplockConfiguration

getSnaplockConfiguration

withSnaplockConfiguration

setVolumeStyle

getVolumeStyle

withVolumeStyle

withVolumeStyle

setAggregateConfiguration

getAggregateConfiguration

withAggregateConfiguration

setSizeInBytes

getSizeInBytes

withSizeInBytes

toString

equals

hashCode

clone

marshall