Class: Aws::CloudWatchLogs::Types::PutRetentionPolicyRequest

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

Overview

Note:

When making an API call, you may pass PutRetentionPolicyRequest data as a hash:

{
  log_group_name: "LogGroupName", # required
  retention_in_days: 1, # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#log_group_nameString

The name of the log group.

Returns:

  • (String)

2308
2309
2310
2311
2312
2313
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2308

class PutRetentionPolicyRequest < Struct.new(
  :log_group_name,
  :retention_in_days)
  SENSITIVE = []
  include Aws::Structure
end

#retention_in_daysInteger

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

To set a log group to never have log events expire, use [DeleteRetentionPolicy].

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html

Returns:

  • (Integer)

2308
2309
2310
2311
2312
2313
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2308

class PutRetentionPolicyRequest < Struct.new(
  :log_group_name,
  :retention_in_days)
  SENSITIVE = []
  include Aws::Structure
end