amazonka-s3-2.0: Amazon Simple Storage Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.S3.Types.DefaultRetention

Description

 
Synopsis

Documentation

data DefaultRetention Source #

The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.

  • The DefaultRetention settings require both a mode and a period.
  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

See: newDefaultRetention smart constructor.

Constructors

DefaultRetention' 

Fields

  • days :: Maybe Int

    The number of days that you want to specify for the default retention period. Must be used with Mode.

  • mode :: Maybe ObjectLockRetentionMode

    The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

  • years :: Maybe Int

    The number of years that you want to specify for the default retention period. Must be used with Mode.

Instances

Instances details
FromXML DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

ToXML DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

Generic DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

Associated Types

type Rep DefaultRetention :: Type -> Type #

Read DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

Show DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

NFData DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

Methods

rnf :: DefaultRetention -> () #

Eq DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

Hashable DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

type Rep DefaultRetention Source # 
Instance details

Defined in Amazonka.S3.Types.DefaultRetention

type Rep DefaultRetention = D1 ('MetaData "DefaultRetention" "Amazonka.S3.Types.DefaultRetention" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DefaultRetention'" 'PrefixI 'True) (S1 ('MetaSel ('Just "days") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLockRetentionMode)) :*: S1 ('MetaSel ('Just "years") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDefaultRetention :: DefaultRetention Source #

Create a value of DefaultRetention with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:days:DefaultRetention', defaultRetention_days - The number of days that you want to specify for the default retention period. Must be used with Mode.

$sel:mode:DefaultRetention', defaultRetention_mode - The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

$sel:years:DefaultRetention', defaultRetention_years - The number of years that you want to specify for the default retention period. Must be used with Mode.

defaultRetention_days :: Lens' DefaultRetention (Maybe Int) Source #

The number of days that you want to specify for the default retention period. Must be used with Mode.

defaultRetention_mode :: Lens' DefaultRetention (Maybe ObjectLockRetentionMode) Source #

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

defaultRetention_years :: Lens' DefaultRetention (Maybe Int) Source #

The number of years that you want to specify for the default retention period. Must be used with Mode.