amazonka-cloudwatch-logs-2.0: Amazon CloudWatch Logs 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.CloudWatchLogs.PutRetentionPolicy

Description

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

Synopsis

Creating a Request

data PutRetentionPolicy Source #

See: newPutRetentionPolicy smart constructor.

Constructors

PutRetentionPolicy' 

Fields

Instances

Instances details
ToJSON PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

ToHeaders PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

ToPath PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

ToQuery PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

AWSRequest PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Associated Types

type AWSResponse PutRetentionPolicy #

Generic PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Associated Types

type Rep PutRetentionPolicy :: Type -> Type #

Read PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Show PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

NFData PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Methods

rnf :: PutRetentionPolicy -> () #

Eq PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Hashable PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

type AWSResponse PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

type Rep PutRetentionPolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

type Rep PutRetentionPolicy = D1 ('MetaData "PutRetentionPolicy" "Amazonka.CloudWatchLogs.PutRetentionPolicy" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "PutRetentionPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "retentionInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutRetentionPolicy Source #

Create a value of PutRetentionPolicy 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:

PutRetentionPolicy, putRetentionPolicy_logGroupName - The name of the log group.

PutRetentionPolicy, putRetentionPolicy_retentionInDays - Undocumented member.

Request Lenses

Destructuring the Response

data PutRetentionPolicyResponse Source #

See: newPutRetentionPolicyResponse smart constructor.

Instances

Instances details
Generic PutRetentionPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Associated Types

type Rep PutRetentionPolicyResponse :: Type -> Type #

Read PutRetentionPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Show PutRetentionPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

NFData PutRetentionPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

Eq PutRetentionPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

type Rep PutRetentionPolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutRetentionPolicy

type Rep PutRetentionPolicyResponse = D1 ('MetaData "PutRetentionPolicyResponse" "Amazonka.CloudWatchLogs.PutRetentionPolicy" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "PutRetentionPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutRetentionPolicyResponse :: PutRetentionPolicyResponse Source #

Create a value of PutRetentionPolicyResponse with all optional fields omitted.

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