com.amazonaws.services.fsx.model

Class SnaplockConfiguration

java.lang.Object

com.amazonaws.services.fsx.model.SnaplockConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SnaplockConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SnaplockConfiguration()

Method Summary

Modifier and Type	Method and Description
SnaplockConfiguration	clone()
boolean	equals(Object obj)
Boolean	getAuditLogVolume() Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
AutocommitPeriod	getAutocommitPeriod() The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
String	getPrivilegedDelete() Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
SnaplockRetentionPeriod	getRetentionPeriod() Specifies the retention period of an FSx for ONTAP SnapLock volume.
String	getSnaplockType() Specifies the retention mode of an FSx for ONTAP SnapLock volume.
Boolean	getVolumeAppendModeEnabled() Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
int	hashCode()
Boolean	isAuditLogVolume() Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
Boolean	isVolumeAppendModeEnabled() Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAuditLogVolume(Boolean auditLogVolume) Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
void	setAutocommitPeriod(AutocommitPeriod autocommitPeriod) The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
void	setPrivilegedDelete(String privilegedDelete) Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
void	setRetentionPeriod(SnaplockRetentionPeriod retentionPeriod) Specifies the retention period of an FSx for ONTAP SnapLock volume.
void	setSnaplockType(String snaplockType) Specifies the retention mode of an FSx for ONTAP SnapLock volume.
void	setVolumeAppendModeEnabled(Boolean volumeAppendModeEnabled) Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
String	toString() Returns a string representation of this object.
SnaplockConfiguration	withAuditLogVolume(Boolean auditLogVolume) Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
SnaplockConfiguration	withAutocommitPeriod(AutocommitPeriod autocommitPeriod) The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
SnaplockConfiguration	withPrivilegedDelete(PrivilegedDelete privilegedDelete) Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
SnaplockConfiguration	withPrivilegedDelete(String privilegedDelete) Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
SnaplockConfiguration	withRetentionPeriod(SnaplockRetentionPeriod retentionPeriod) Specifies the retention period of an FSx for ONTAP SnapLock volume.
SnaplockConfiguration	withSnaplockType(SnaplockType snaplockType) Specifies the retention mode of an FSx for ONTAP SnapLock volume.
SnaplockConfiguration	withSnaplockType(String snaplockType) Specifies the retention mode of an FSx for ONTAP SnapLock volume.
SnaplockConfiguration	withVolumeAppendModeEnabled(Boolean volumeAppendModeEnabled) Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SnaplockConfiguration

public SnaplockConfiguration()

Method Detail

setAuditLogVolume

public void setAuditLogVolume(Boolean auditLogVolume)

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

Parameters:

auditLogVolume - Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

getAuditLogVolume

public Boolean getAuditLogVolume()

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

Returns:

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

withAuditLogVolume

public SnaplockConfiguration withAuditLogVolume(Boolean auditLogVolume)

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

Parameters:

auditLogVolume - Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAuditLogVolume

public Boolean isAuditLogVolume()

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

Returns:

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

For more information, see SnapLock audit log volumes.

setAutocommitPeriod

public void setAutocommitPeriod(AutocommitPeriod autocommitPeriod)

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Parameters:

autocommitPeriod - The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

getAutocommitPeriod

public AutocommitPeriod getAutocommitPeriod()

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Returns:

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

withAutocommitPeriod

public SnaplockConfiguration withAutocommitPeriod(AutocommitPeriod autocommitPeriod)

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Parameters:

autocommitPeriod - The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPrivilegedDelete

public void setPrivilegedDelete(String privilegedDelete)

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

Parameters:

privilegedDelete - Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

See Also:

PrivilegedDelete

getPrivilegedDelete

public String getPrivilegedDelete()

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

Returns:

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

See Also:

PrivilegedDelete

withPrivilegedDelete

public SnaplockConfiguration withPrivilegedDelete(String privilegedDelete)

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

Parameters:

privilegedDelete - Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PrivilegedDelete

withPrivilegedDelete

public SnaplockConfiguration withPrivilegedDelete(PrivilegedDelete privilegedDelete)

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

Parameters:

privilegedDelete - Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

For more information, see Privileged delete.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PrivilegedDelete

setRetentionPeriod

public void setRetentionPeriod(SnaplockRetentionPeriod retentionPeriod)

Specifies the retention period of an FSx for ONTAP SnapLock volume.

Parameters:

retentionPeriod - Specifies the retention period of an FSx for ONTAP SnapLock volume.

getRetentionPeriod

public SnaplockRetentionPeriod getRetentionPeriod()

Specifies the retention period of an FSx for ONTAP SnapLock volume.

Returns:

Specifies the retention period of an FSx for ONTAP SnapLock volume.

withRetentionPeriod

public SnaplockConfiguration withRetentionPeriod(SnaplockRetentionPeriod retentionPeriod)

Specifies the retention period of an FSx for ONTAP SnapLock volume.

Parameters:

retentionPeriod - Specifies the retention period of an FSx for ONTAP SnapLock volume.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSnaplockType

public void setSnaplockType(String snaplockType)

Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

Parameters:

snaplockType - Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

See Also:

SnaplockType

getSnaplockType

public String getSnaplockType()

Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

Returns:

Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

See Also:

SnaplockType

withSnaplockType

public SnaplockConfiguration withSnaplockType(String snaplockType)

Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

Parameters:

snaplockType - Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SnaplockType

withSnaplockType

public SnaplockConfiguration withSnaplockType(SnaplockType snaplockType)

Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

Parameters:

snaplockType - Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

• COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

• ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SnaplockType

setVolumeAppendModeEnabled

public void setVolumeAppendModeEnabled(Boolean volumeAppendModeEnabled)

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

Parameters:

volumeAppendModeEnabled - Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

getVolumeAppendModeEnabled

public Boolean getVolumeAppendModeEnabled()

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

Returns:

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

withVolumeAppendModeEnabled

public SnaplockConfiguration withVolumeAppendModeEnabled(Boolean volumeAppendModeEnabled)

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

Parameters:

volumeAppendModeEnabled - Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

isVolumeAppendModeEnabled

public Boolean isVolumeAppendModeEnabled()

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

Returns:

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

For more information, see Volume-append mode.

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 SnaplockConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo