Package 

Enum RetentionMode

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum RetentionMode
extends Enum<RetentionMode>

    S3 Retention Modes

    S3 Object Lock provides two retention modes:

    • Governance mode

    • Compliance mode

    These retention modes apply different levels of protection to your objects. You can apply either retention mode to any object version that is protected by Object Lock.

    In governance mode, users can't overwrite or delete an object version or alter its lock settings unless they have special permissions. With governance mode, you protect objects against being deleted by most users, but you can still grant some users permission to alter the retention settings or delete the object if necessary. You can also use governance mode to test retention-period settings before creating a compliance-mode retention period.

    To override or remove governance-mode retention settings, a user must have the s3:BypassGovernanceRetention permission and must explicitly include x-amz-bypass-governance-retention:true as a request header with any request that requires overriding governance mode.

    In compliance mode, a protected object version can't be overwritten or deleted by any user, including the root user in your AWS account. When an object is locked in compliance mode, its retention mode can't be changed, and its retention period can't be shortened. Compliance mode helps ensure that an object version can't be overwritten or deleted for the duration of the retention period.

    Note Updating an object version's metadata, as occurs when you place or alter an Object Lock, doesn't overwrite the object version or reset its Last-Modified timestamp.

    • Constructor Summary

      Constructors 
      Constructor Description

    • Method Summary

      Modifier and Type Method Description
      String toString()
      final RetentionMode valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<RetentionMode> values() Returns an array containing the constants of this enum type, in the order they're declared.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • valueOf

         final RetentionMode valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<RetentionMode> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.