Class: Aws::FSx::Types::CreateSnaplockConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_log_volume ⇒ Boolean

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

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume

Returns:

  • (Boolean) 


2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/aws-sdk-fsx/types.rb', line 2831

class CreateSnaplockConfiguration < Struct.new(
  :audit_log_volume,
  :autocommit_period,
  :privileged_delete,
  :retention_period,
  :snaplock_type,
  :volume_append_mode_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#autocommit_period ⇒ Types::AutocommitPeriod

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

Returns:



2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/aws-sdk-fsx/types.rb', line 2831

class CreateSnaplockConfiguration < Struct.new(
  :audit_log_volume,
  :autocommit_period,
  :privileged_delete,
  :retention_period,
  :snaplock_type,
  :volume_append_mode_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#privileged_delete ⇒ String

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete 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].

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete

Returns:

  • (String) 


2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/aws-sdk-fsx/types.rb', line 2831

class CreateSnaplockConfiguration < Struct.new(
  :audit_log_volume,
  :autocommit_period,
  :privileged_delete,
  :retention_period,
  :snaplock_type,
  :volume_append_mode_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::SnaplockRetentionPeriod

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

Returns:



2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/aws-sdk-fsx/types.rb', line 2831

class CreateSnaplockConfiguration < Struct.new(
  :audit_log_volume,
  :autocommit_period,
  :privileged_delete,
  :retention_period,
  :snaplock_type,
  :volume_append_mode_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#snaplock_type ⇒ String

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

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html [2]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html

Returns:

  • (String) 


2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/aws-sdk-fsx/types.rb', line 2831

class CreateSnaplockConfiguration < Struct.new(
  :audit_log_volume,
  :autocommit_period,
  :privileged_delete,
  :retention_period,
  :snaplock_type,
  :volume_append_mode_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#volume_append_mode_enabled ⇒ Boolean

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

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append

Returns:

  • (Boolean) 


2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/aws-sdk-fsx/types.rb', line 2831

class CreateSnaplockConfiguration < Struct.new(
  :audit_log_volume,
  :autocommit_period,
  :privileged_delete,
  :retention_period,
  :snaplock_type,
  :volume_append_mode_enabled)
  SENSITIVE = []
  include Aws::Structure
end