@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.
Constructor and Description |
---|
CreateOntapVolumeConfiguration() |
Modifier and Type | Method and Description |
---|---|
CreateOntapVolumeConfiguration |
clone() |
boolean |
equals(Object obj) |
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.
|
Integer |
getSizeInMegabytes()
Specifies the size of the volume, in megabytes (MB), that you are creating.
|
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() |
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 |
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 |
setSizeInMegabytes(Integer sizeInMegabytes)
Specifies the size of the volume, in megabytes (MB), that you are creating.
|
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) |
String |
toString()
Returns a string representation of this object.
|
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 |
withSizeInMegabytes(Integer sizeInMegabytes)
Specifies the size of the volume, in megabytes (MB), that you are creating.
|
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) |
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
.
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
.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
.
JunctionPath
must have a leading forward slash, such as /vol3
.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
.
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
.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. 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
if the file system is managed by both UNIX and Windows administrators and users consist of
both NFS and SMB clients.
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
if the file system is managed by both UNIX and Windows administrators and users consist
of both NFS and SMB clients.
SecurityStyle
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. 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
if the file system is managed by both UNIX and Windows administrators and users consist of
both NFS and SMB clients.
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
if the file system is managed by both UNIX and Windows administrators and users
consist of both NFS and SMB clients.
SecurityStyle
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. 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
if the file system is managed by both UNIX and Windows administrators and users consist of
both NFS and SMB clients.
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
if the file system is managed by both UNIX and Windows administrators and users consist
of both NFS and SMB clients.
SecurityStyle
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. 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
if the file system is managed by both UNIX and Windows administrators and users consist of
both NFS and SMB clients.
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
if the file system is managed by both UNIX and Windows administrators and users consist
of both NFS and SMB clients.
SecurityStyle
public void setSizeInMegabytes(Integer sizeInMegabytes)
Specifies the size of the volume, in megabytes (MB), that you are creating. Provide any whole number in the range of 20–104857600 to specify the size of the volume.
sizeInMegabytes
- Specifies the size of the volume, in megabytes (MB), that you are creating. Provide any whole number in
the range of 20–104857600 to specify the size of the volume.public Integer getSizeInMegabytes()
Specifies the size of the volume, in megabytes (MB), that you are creating. Provide any whole number in the range of 20–104857600 to specify the size of the volume.
public CreateOntapVolumeConfiguration withSizeInMegabytes(Integer sizeInMegabytes)
Specifies the size of the volume, in megabytes (MB), that you are creating. Provide any whole number in the range of 20–104857600 to specify the size of the volume.
sizeInMegabytes
- Specifies the size of the volume, in megabytes (MB), that you are creating. Provide any whole number in
the range of 20–104857600 to specify the size of the volume.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. This parameter is required.
storageEfficiencyEnabled
- Set to true to enable deduplication, compression, and compaction storage efficiency features on the
volume, or set to false to disable them. This parameter is required.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. This parameter is required.
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. This parameter is required.
storageEfficiencyEnabled
- Set to true to enable deduplication, compression, and compaction storage efficiency features on the
volume, or set to false to disable them. This parameter is required.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. This parameter is required.
public void setStorageVirtualMachineId(String storageVirtualMachineId)
Specifies the ONTAP SVM in which to create the volume.
storageVirtualMachineId
- Specifies the ONTAP SVM in which to create the volume.public String getStorageVirtualMachineId()
Specifies the ONTAP SVM in which to create the volume.
public CreateOntapVolumeConfiguration withStorageVirtualMachineId(String storageVirtualMachineId)
Specifies the ONTAP SVM in which to create the volume.
storageVirtualMachineId
- Specifies the ONTAP SVM in which to create the volume.public void setTieringPolicy(TieringPolicy tieringPolicy)
tieringPolicy
- public TieringPolicy getTieringPolicy()
public CreateOntapVolumeConfiguration withTieringPolicy(TieringPolicy tieringPolicy)
tieringPolicy
- 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.
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.
InputOntapVolumeType
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.
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.
InputOntapVolumeType
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.
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.
InputOntapVolumeType
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.
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.
InputOntapVolumeType
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.
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.
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.
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.
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.
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.
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.
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.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.
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.
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.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.
public String toString()
toString
in class Object
Object.toString()
public CreateOntapVolumeConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.