aws-sdk-cloudwatchlogs 1.172.0 → 1.173.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchlogs/client.rb +170 -21
- data/lib/aws-sdk-cloudwatchlogs/types.rb +55 -7
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- data/sig/client.rbs +4 -4
- data/sig/types.rbs +6 -6
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1d7b4c180aaf3c6a6d529f98cb25ea274b5f84eed4768219f16f0c72975103f4
|
|
4
|
+
data.tar.gz: b11975106533fcff541266f5a35198803f474e32e718e8933a9409b8267688c3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 65fedde140accc5ffd7c61d4228dffb6c5498adce0cffb9a37b33fa65f80537b04ec16f0788a397983a305782d55d4df22012d4159a8df6af6208c15e7c5e6fb
|
|
7
|
+
data.tar.gz: 12cc8ee636570a4ff2093878845b23cdbee0c0598e9b75ce381efe78931eacfc2420029de1aa5c3fefbec918a3a6ebdb80cea19bc809c151bb3a00030ef2c4a8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.173.0 (2026-11-05)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds account-level retention policies with dry run preview and the Essentials log group class to Amazon CloudWatch Logs
|
|
8
|
+
|
|
4
9
|
1.172.0 (2026-11-04)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.173.0
|
|
@@ -1257,13 +1257,16 @@ module Aws::CloudWatchLogs
|
|
|
1257
1257
|
#
|
|
1258
1258
|
# @option params [String] :log_group_class
|
|
1259
1259
|
# Use this parameter to specify the log group class for this log group.
|
|
1260
|
-
# There are
|
|
1260
|
+
# There are four classes:
|
|
1261
1261
|
#
|
|
1262
1262
|
# * The `Standard` log class supports all CloudWatch Logs features.
|
|
1263
1263
|
#
|
|
1264
1264
|
# * The `Infrequent Access` log class supports a subset of CloudWatch
|
|
1265
1265
|
# Logs features and incurs lower costs.
|
|
1266
1266
|
#
|
|
1267
|
+
# * The `Essentials` log class supports a subset of CloudWatch Logs
|
|
1268
|
+
# features and incurs lower costs.
|
|
1269
|
+
#
|
|
1267
1270
|
# * Use the `Delivery` log class only for delivering Lambda logs to
|
|
1268
1271
|
# store in Amazon S3 or Amazon Data Firehose. Log events in log groups
|
|
1269
1272
|
# in the Delivery class are kept in CloudWatch Logs for only one day.
|
|
@@ -1298,7 +1301,7 @@ module Aws::CloudWatchLogs
|
|
|
1298
1301
|
# tags: {
|
|
1299
1302
|
# "TagKey" => "TagValue",
|
|
1300
1303
|
# },
|
|
1301
|
-
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY
|
|
1304
|
+
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY, ESSENTIALS
|
|
1302
1305
|
# deletion_protection_enabled: false,
|
|
1303
1306
|
# })
|
|
1304
1307
|
#
|
|
@@ -1559,10 +1562,13 @@ module Aws::CloudWatchLogs
|
|
|
1559
1562
|
# Deletes a CloudWatch Logs account policy. This stops the account-wide
|
|
1560
1563
|
# policy from applying to log groups or data sources in the account. If
|
|
1561
1564
|
# you delete a data protection policy or subscription filter policy, any
|
|
1562
|
-
# log-group level policies of those types remain in effect.
|
|
1563
|
-
#
|
|
1564
|
-
#
|
|
1565
|
-
#
|
|
1565
|
+
# log-group level policies of those types remain in effect. If you
|
|
1566
|
+
# delete a retention policy, the log groups that it applied to use their
|
|
1567
|
+
# own retention setting, unless another retention policy applies to
|
|
1568
|
+
# them. Deleting a retention policy does not restore log events that
|
|
1569
|
+
# CloudWatch Logs has already deleted. This operation supports deletion
|
|
1570
|
+
# of data source-based field index policies, including facet
|
|
1571
|
+
# configurations, in addition to log group-based policies.
|
|
1566
1572
|
#
|
|
1567
1573
|
# To use this operation, you must be signed on with the correct
|
|
1568
1574
|
# permissions depending on the type of policy that you are deleting.
|
|
@@ -1586,6 +1592,12 @@ module Aws::CloudWatchLogs
|
|
|
1586
1592
|
# interactive exploration in the CloudWatch Logs Insights console.
|
|
1587
1593
|
# However, facet data is retained for up to 30 days.
|
|
1588
1594
|
#
|
|
1595
|
+
# * To delete a retention policy, you must have the
|
|
1596
|
+
# `logs:DeleteRetentionPolicy` and `logs:DeleteAccountPolicy`
|
|
1597
|
+
# permissions. To preview the impact of deleting a retention policy,
|
|
1598
|
+
# specify `true` for `dryRun`. A dry run requires the same permissions
|
|
1599
|
+
# as the operation that it previews, and no additional permissions.
|
|
1600
|
+
#
|
|
1589
1601
|
# If you delete a field index policy, the indexing of the log events
|
|
1590
1602
|
# that happened before you deleted the policy will still be used for up
|
|
1591
1603
|
# to 30 days to improve CloudWatch Logs Insights queries.
|
|
@@ -2117,6 +2129,15 @@ module Aws::CloudWatchLogs
|
|
|
2117
2129
|
# Log events do not expire if they belong to log groups without a
|
|
2118
2130
|
# retention policy.
|
|
2119
2131
|
#
|
|
2132
|
+
# If an account-level retention policy applies to this log group, the
|
|
2133
|
+
# log group uses the retention period from that policy. For more
|
|
2134
|
+
# information about account-level retention policies, see
|
|
2135
|
+
# [PutAccountPolicy][1].
|
|
2136
|
+
#
|
|
2137
|
+
#
|
|
2138
|
+
#
|
|
2139
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html
|
|
2140
|
+
#
|
|
2120
2141
|
# @option params [required, String] :log_group_name
|
|
2121
2142
|
# The name of the log group.
|
|
2122
2143
|
#
|
|
@@ -2270,6 +2291,9 @@ module Aws::CloudWatchLogs
|
|
|
2270
2291
|
# `logs:DescribeIndexPolicies` and `logs:DescribeAccountPolicies`
|
|
2271
2292
|
# permissions.
|
|
2272
2293
|
#
|
|
2294
|
+
# * To see retention policies, you must have the
|
|
2295
|
+
# `logs:DescribeAccountPolicies` permission.
|
|
2296
|
+
#
|
|
2273
2297
|
# @option params [required, String] :policy_type
|
|
2274
2298
|
# Use this parameter to limit the returned policies to only the policies
|
|
2275
2299
|
# that match the policy type that you specify.
|
|
@@ -2974,6 +2998,10 @@ module Aws::CloudWatchLogs
|
|
|
2974
2998
|
# filter the results by prefix. The results are ASCII-sorted by log
|
|
2975
2999
|
# group name.
|
|
2976
3000
|
#
|
|
3001
|
+
# If an account-level retention policy applies to a log group,
|
|
3002
|
+
# `retentionInDays` shows the retention period from that policy, and
|
|
3003
|
+
# `retentionPolicyName` shows the name of the policy.
|
|
3004
|
+
#
|
|
2977
3005
|
# CloudWatch Logs doesn't support IAM policies that control access to
|
|
2978
3006
|
# the `DescribeLogGroups` action by using the `aws:ResourceTag/key-name
|
|
2979
3007
|
# ` condition key. Other CloudWatch Logs actions do support the use of
|
|
@@ -3045,7 +3073,11 @@ module Aws::CloudWatchLogs
|
|
|
3045
3073
|
# the specified log group class. If you omit this parameter, log groups
|
|
3046
3074
|
# of all classes can be returned.
|
|
3047
3075
|
#
|
|
3048
|
-
#
|
|
3076
|
+
# If you specify either `INFREQUENT_ACCESS` or `ESSENTIALS`, the results
|
|
3077
|
+
# include log groups in both the Infrequent Access and Essentials log
|
|
3078
|
+
# classes.
|
|
3079
|
+
#
|
|
3080
|
+
# Specifies the log group class for this log group. There are four
|
|
3049
3081
|
# classes:
|
|
3050
3082
|
#
|
|
3051
3083
|
# * The `Standard` log class supports all CloudWatch Logs features.
|
|
@@ -3053,6 +3085,9 @@ module Aws::CloudWatchLogs
|
|
|
3053
3085
|
# * The `Infrequent Access` log class supports a subset of CloudWatch
|
|
3054
3086
|
# Logs features and incurs lower costs.
|
|
3055
3087
|
#
|
|
3088
|
+
# * The `Essentials` log class supports a subset of CloudWatch Logs
|
|
3089
|
+
# features and incurs lower costs.
|
|
3090
|
+
#
|
|
3056
3091
|
# * Use the `Delivery` log class only for delivering Lambda logs to
|
|
3057
3092
|
# store in Amazon S3 or Amazon Data Firehose. Log events in log groups
|
|
3058
3093
|
# in the Delivery class are kept in CloudWatch Logs for only one day.
|
|
@@ -3093,7 +3128,7 @@ module Aws::CloudWatchLogs
|
|
|
3093
3128
|
# next_token: "NextToken",
|
|
3094
3129
|
# limit: 1,
|
|
3095
3130
|
# include_linked_accounts: false,
|
|
3096
|
-
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY
|
|
3131
|
+
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY, ESSENTIALS
|
|
3097
3132
|
# log_group_identifiers: ["LogGroupIdentifier"],
|
|
3098
3133
|
# })
|
|
3099
3134
|
#
|
|
@@ -3110,7 +3145,7 @@ module Aws::CloudWatchLogs
|
|
|
3110
3145
|
# resp.log_groups[0].data_protection_status #=> String, one of "ACTIVATED", "DELETED", "ARCHIVED", "DISABLED"
|
|
3111
3146
|
# resp.log_groups[0].inherited_properties #=> Array
|
|
3112
3147
|
# resp.log_groups[0].inherited_properties[0] #=> String, one of "ACCOUNT_DATA_PROTECTION"
|
|
3113
|
-
# resp.log_groups[0].log_group_class #=> String, one of "STANDARD", "INFREQUENT_ACCESS", "DELIVERY"
|
|
3148
|
+
# resp.log_groups[0].log_group_class #=> String, one of "STANDARD", "INFREQUENT_ACCESS", "DELIVERY", "ESSENTIALS"
|
|
3114
3149
|
# resp.log_groups[0].log_group_arn #=> String
|
|
3115
3150
|
# resp.log_groups[0].deletion_protection_enabled #=> Boolean
|
|
3116
3151
|
# resp.log_groups[0].bearer_token_authentication_enabled #=> Boolean
|
|
@@ -5275,7 +5310,7 @@ module Aws::CloudWatchLogs
|
|
|
5275
5310
|
# resp = client.list_aggregate_log_group_summaries({
|
|
5276
5311
|
# account_identifiers: ["AccountId"],
|
|
5277
5312
|
# include_linked_accounts: false,
|
|
5278
|
-
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY
|
|
5313
|
+
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY, ESSENTIALS
|
|
5279
5314
|
# log_group_name_pattern: "LogGroupNameRegexPattern",
|
|
5280
5315
|
# data_sources: [
|
|
5281
5316
|
# {
|
|
@@ -5580,7 +5615,7 @@ module Aws::CloudWatchLogs
|
|
|
5580
5615
|
#
|
|
5581
5616
|
# resp = client.list_log_groups({
|
|
5582
5617
|
# log_group_name_pattern: "LogGroupNameRegexPattern",
|
|
5583
|
-
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY
|
|
5618
|
+
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY, ESSENTIALS
|
|
5584
5619
|
# include_linked_accounts: false,
|
|
5585
5620
|
# account_identifiers: ["AccountId"],
|
|
5586
5621
|
# next_token: "NextToken",
|
|
@@ -5605,7 +5640,7 @@ module Aws::CloudWatchLogs
|
|
|
5605
5640
|
# resp.log_groups #=> Array
|
|
5606
5641
|
# resp.log_groups[0].log_group_name #=> String
|
|
5607
5642
|
# resp.log_groups[0].log_group_arn #=> String
|
|
5608
|
-
# resp.log_groups[0].log_group_class #=> String, one of "STANDARD", "INFREQUENT_ACCESS", "DELIVERY"
|
|
5643
|
+
# resp.log_groups[0].log_group_class #=> String, one of "STANDARD", "INFREQUENT_ACCESS", "DELIVERY", "ESSENTIALS"
|
|
5609
5644
|
# resp.next_token #=> String
|
|
5610
5645
|
#
|
|
5611
5646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListLogGroups AWS API Documentation
|
|
@@ -5924,12 +5959,13 @@ module Aws::CloudWatchLogs
|
|
|
5924
5959
|
end
|
|
5925
5960
|
|
|
5926
5961
|
# Creates an account-level data protection policy, subscription filter
|
|
5927
|
-
# policy, field index policy, transformer policy,
|
|
5928
|
-
# policy that applies to all log groups, a subset
|
|
5929
|
-
# data source name and type combination in the
|
|
5930
|
-
# policies are Region-specific: a policy applies
|
|
5931
|
-
# the Region where you create it. To apply a
|
|
5932
|
-
# Regions, create the policy separately in each
|
|
5962
|
+
# policy, field index policy, transformer policy, metric extraction
|
|
5963
|
+
# policy, or retention policy that applies to all log groups, a subset
|
|
5964
|
+
# of log groups, or a data source name and type combination in the
|
|
5965
|
+
# account. Account-level policies are Region-specific: a policy applies
|
|
5966
|
+
# only to log groups in the Region where you create it. To apply a
|
|
5967
|
+
# policy across multiple Regions, create the policy separately in each
|
|
5968
|
+
# Region.
|
|
5933
5969
|
#
|
|
5934
5970
|
# `PutAccountPolicy` is an account-wide administrative operation
|
|
5935
5971
|
# intended for CloudWatch Logs administrators. Because it affects all
|
|
@@ -5969,6 +6005,9 @@ module Aws::CloudWatchLogs
|
|
|
5969
6005
|
# account-level only and have no log-group-level equivalent, so no
|
|
5970
6006
|
# conflict resolution applies.
|
|
5971
6007
|
#
|
|
6008
|
+
# * *Retention policies* — An account-level retention policy overrides
|
|
6009
|
+
# the retention setting of the log group.
|
|
6010
|
+
#
|
|
5972
6011
|
# For field index policies, you can configure indexed fields as *facets*
|
|
5973
6012
|
# to enable interactive exploration of your logs. Facets provide value
|
|
5974
6013
|
# distributions and counts for indexed fields in the CloudWatch Logs
|
|
@@ -5999,6 +6038,11 @@ module Aws::CloudWatchLogs
|
|
|
5999
6038
|
# `logs:PutMetricExtractionPolicy` and `logs:PutAccountPolicy`
|
|
6000
6039
|
# permissions.
|
|
6001
6040
|
#
|
|
6041
|
+
# * To create a retention policy, you must have the
|
|
6042
|
+
# `logs:PutRetentionPolicy` and `logs:PutAccountPolicy` permissions. A
|
|
6043
|
+
# dry run requires the same permissions as the operation that it
|
|
6044
|
+
# previews, and no additional permissions.
|
|
6045
|
+
#
|
|
6002
6046
|
# **Data protection policy**
|
|
6003
6047
|
#
|
|
6004
6048
|
# A data protection policy can help safeguard sensitive data that's
|
|
@@ -6319,6 +6363,60 @@ module Aws::CloudWatchLogs
|
|
|
6319
6363
|
# groups matching `"/aws"` is not a subset of the log groups matching
|
|
6320
6364
|
# `"/aws/lambda"`.
|
|
6321
6365
|
#
|
|
6366
|
+
# **Retention policy**
|
|
6367
|
+
#
|
|
6368
|
+
# A retention policy sets the retention period for log groups in your
|
|
6369
|
+
# account. You can use an account-level retention policy to set a
|
|
6370
|
+
# default retention period for all log groups in the account, or for a
|
|
6371
|
+
# subset of log groups that you specify with the `selectionCriteria`
|
|
6372
|
+
# parameter. CloudWatch Logs automatically deletes log events that are
|
|
6373
|
+
# older than the retention period.
|
|
6374
|
+
#
|
|
6375
|
+
# Each account can have up to 20 account-level retention policies in
|
|
6376
|
+
# each Region. To scope a retention policy to a subset of log groups,
|
|
6377
|
+
# use `LogGroupNamePrefix` in `selectionCriteria`. Retention policies
|
|
6378
|
+
# support log group name prefixes only. If you omit `selectionCriteria`,
|
|
6379
|
+
# the policy applies to all log groups in the account.
|
|
6380
|
+
#
|
|
6381
|
+
# Unlike other account-level policy types, retention policies can have
|
|
6382
|
+
# overlapping selection criteria. When more than one retention policy
|
|
6383
|
+
# applies to a log group, the policy with the longest retention period
|
|
6384
|
+
# is used. A policy that specifies `NEVER_EXPIRE` is treated as the
|
|
6385
|
+
# longest retention period. This lets you set a baseline retention
|
|
6386
|
+
# period for the account, apply longer retention periods to specific log
|
|
6387
|
+
# groups, and exempt specific log groups from expiring at all. If two
|
|
6388
|
+
# policies that apply to the same log group specify the same retention
|
|
6389
|
+
# period, the policy that was created first is the one reported in
|
|
6390
|
+
# `retentionPolicyName`.
|
|
6391
|
+
#
|
|
6392
|
+
# <note markdown="1"> Account-level retention policies require a minimum retention period of
|
|
6393
|
+
# 30 days.
|
|
6394
|
+
#
|
|
6395
|
+
# </note>
|
|
6396
|
+
#
|
|
6397
|
+
# <note markdown="1"> A retention policy takes effect 24 hours after you create it. If you
|
|
6398
|
+
# update a policy, the new retention period takes effect 24 hours after
|
|
6399
|
+
# the update, and the previous retention period stays in effect until
|
|
6400
|
+
# then. During this period, `DescribeLogGroups` and log event expiration
|
|
6401
|
+
# use the retention period that is currently in effect, but a dry run
|
|
6402
|
+
# reports the impact as if the policy were already in effect.
|
|
6403
|
+
#
|
|
6404
|
+
# </note>
|
|
6405
|
+
#
|
|
6406
|
+
# Before you create, update, or delete a retention policy, you can
|
|
6407
|
+
# specify `true` for `dryRun` to preview how many log groups would have
|
|
6408
|
+
# a longer, shorter, or unchanged retention period. For more
|
|
6409
|
+
# information, see [DryRunResult][14].
|
|
6410
|
+
#
|
|
6411
|
+
# An account-level retention policy replaces the retention period set on
|
|
6412
|
+
# a log group, including when the log group's own retention period is
|
|
6413
|
+
# longer. For example, if a log group is set to retain log events for 10
|
|
6414
|
+
# years and you create a retention policy that sets a 90-day retention
|
|
6415
|
+
# period for that log group, CloudWatch Logs deletes the log events in
|
|
6416
|
+
# that log group that are older than 90 days. Specify `true` for
|
|
6417
|
+
# `dryRun` to see which log groups would have a shorter retention period
|
|
6418
|
+
# before you create or update the policy.
|
|
6419
|
+
#
|
|
6322
6420
|
#
|
|
6323
6421
|
#
|
|
6324
6422
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Facets.html
|
|
@@ -6334,6 +6432,7 @@ module Aws::CloudWatchLogs
|
|
|
6334
6432
|
# [11]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogFields.html
|
|
6335
6433
|
# [12]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Syntax
|
|
6336
6434
|
# [13]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html
|
|
6435
|
+
# [14]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DryRunResult.html
|
|
6337
6436
|
#
|
|
6338
6437
|
# @option params [required, String] :policy_name
|
|
6339
6438
|
# A name for the policy. This must be unique within the account and
|
|
@@ -6445,6 +6544,36 @@ module Aws::CloudWatchLogs
|
|
|
6445
6544
|
# types are `FIELD_INDEX` and `FACET`. Field names within `Fields` and
|
|
6446
6545
|
# `FieldsV2` must be mutually exclusive.
|
|
6447
6546
|
#
|
|
6547
|
+
# **Retention policy**
|
|
6548
|
+
#
|
|
6549
|
+
# A retention policy must include the following attributes in a JSON
|
|
6550
|
+
# block:
|
|
6551
|
+
#
|
|
6552
|
+
# retentionInDays
|
|
6553
|
+
#
|
|
6554
|
+
# : The number of days to retain log events. Valid values are 30, 60,
|
|
6555
|
+
# 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922,
|
|
6556
|
+
# 3288, and 3653. To retain log events indefinitely, specify the
|
|
6557
|
+
# string `NEVER_EXPIRE`.
|
|
6558
|
+
#
|
|
6559
|
+
# enforcementMode
|
|
6560
|
+
#
|
|
6561
|
+
# : Specifies which log groups the policy applies to. Valid values are
|
|
6562
|
+
# `NEW_ONLY` and `RETROACTIVE`.
|
|
6563
|
+
#
|
|
6564
|
+
# `RETROACTIVE` applies the policy to every log group that matches the
|
|
6565
|
+
# selection criteria, including log groups that existed before you
|
|
6566
|
+
# created the policy.
|
|
6567
|
+
#
|
|
6568
|
+
# `NEW_ONLY` applies the policy only to log groups that are created
|
|
6569
|
+
# after you create the policy. Log groups that already existed when
|
|
6570
|
+
# you created the policy keep their own retention period.
|
|
6571
|
+
#
|
|
6572
|
+
# The following is an example of a retention policy document.
|
|
6573
|
+
#
|
|
6574
|
+
# `"policyDocument": "{"retentionInDays": 90, "enforcementMode":
|
|
6575
|
+
# "RETROACTIVE"}"`
|
|
6576
|
+
#
|
|
6448
6577
|
#
|
|
6449
6578
|
#
|
|
6450
6579
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html
|
|
@@ -6464,8 +6593,8 @@ module Aws::CloudWatchLogs
|
|
|
6464
6593
|
# in the account or a data source name and type combination.
|
|
6465
6594
|
#
|
|
6466
6595
|
# Specifying `selectionCriteria` is valid only when you specify
|
|
6467
|
-
# `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY
|
|
6468
|
-
# `TRANSFORMER_POLICY`for `policyType`.
|
|
6596
|
+
# `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY`,
|
|
6597
|
+
# `TRANSFORMER_POLICY`, or `RETENTION_POLICY` for `policyType`.
|
|
6469
6598
|
#
|
|
6470
6599
|
# * If `policyType` is `SUBSCRIPTION_FILTER_POLICY`, the only supported
|
|
6471
6600
|
# `selectionCriteria` filter is `LogGroupName NOT IN []`
|
|
@@ -6483,6 +6612,11 @@ module Aws::CloudWatchLogs
|
|
|
6483
6612
|
# can use either `LogGroupNamePrefix` by itself or `DataSourceName`
|
|
6484
6613
|
# and `DataSourceType` together.
|
|
6485
6614
|
#
|
|
6615
|
+
# * If `policyType` is `RETENTION_POLICY`, the only supported
|
|
6616
|
+
# `selectionCriteria` filter is `LogGroupNamePrefix`. If you omit
|
|
6617
|
+
# `selectionCriteria`, the retention policy applies to all log groups
|
|
6618
|
+
# in the account.
|
|
6619
|
+
#
|
|
6486
6620
|
# The `selectionCriteria` string can be up to 25KB in length. The length
|
|
6487
6621
|
# is determined by using its UTF-8 bytes.
|
|
6488
6622
|
#
|
|
@@ -7973,6 +8107,17 @@ module Aws::CloudWatchLogs
|
|
|
7973
8107
|
# policy, you can configure the number of days for which to retain log
|
|
7974
8108
|
# events in the specified log group.
|
|
7975
8109
|
#
|
|
8110
|
+
# Account-level retention policies created with [PutAccountPolicy][1]
|
|
8111
|
+
# override the retention that you set with `PutRetentionPolicy`. If an
|
|
8112
|
+
# account-level retention policy applies to the log group, this
|
|
8113
|
+
# operation succeeds and CloudWatch Logs saves the retention period that
|
|
8114
|
+
# you specify, but the retention period from the account-level policy
|
|
8115
|
+
# continues to determine when log events in the log group expire.
|
|
8116
|
+
# `DescribeLogGroups` returns the retention period from the policy in
|
|
8117
|
+
# `retentionInDays` and the name of the policy in `retentionPolicyName`.
|
|
8118
|
+
# The retention period that you set with this operation takes effect if
|
|
8119
|
+
# the account-level policy no longer applies to the log group.
|
|
8120
|
+
#
|
|
7976
8121
|
# <note markdown="1"> CloudWatch Logs doesn't immediately delete log events when they reach
|
|
7977
8122
|
# their retention setting. It typically takes up to 72 hours after that
|
|
7978
8123
|
# before log events are deleted, but in rare situations might take
|
|
@@ -7996,6 +8141,10 @@ module Aws::CloudWatchLogs
|
|
|
7996
8141
|
#
|
|
7997
8142
|
# </note>
|
|
7998
8143
|
#
|
|
8144
|
+
#
|
|
8145
|
+
#
|
|
8146
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html
|
|
8147
|
+
#
|
|
7999
8148
|
# @option params [required, String] :log_group_name
|
|
8000
8149
|
# The name of the log group.
|
|
8001
8150
|
#
|
|
@@ -9786,7 +9935,7 @@ module Aws::CloudWatchLogs
|
|
|
9786
9935
|
tracer: tracer
|
|
9787
9936
|
)
|
|
9788
9937
|
context[:gem_name] = 'aws-sdk-cloudwatchlogs'
|
|
9789
|
-
context[:gem_version] = '1.
|
|
9938
|
+
context[:gem_version] = '1.173.0'
|
|
9790
9939
|
Seahorse::Client::Request.new(handlers, context)
|
|
9791
9940
|
end
|
|
9792
9941
|
|
|
@@ -1082,13 +1082,16 @@ module Aws::CloudWatchLogs
|
|
|
1082
1082
|
#
|
|
1083
1083
|
# @!attribute [rw] log_group_class
|
|
1084
1084
|
# Use this parameter to specify the log group class for this log
|
|
1085
|
-
# group. There are
|
|
1085
|
+
# group. There are four classes:
|
|
1086
1086
|
#
|
|
1087
1087
|
# * The `Standard` log class supports all CloudWatch Logs features.
|
|
1088
1088
|
#
|
|
1089
1089
|
# * The `Infrequent Access` log class supports a subset of CloudWatch
|
|
1090
1090
|
# Logs features and incurs lower costs.
|
|
1091
1091
|
#
|
|
1092
|
+
# * The `Essentials` log class supports a subset of CloudWatch Logs
|
|
1093
|
+
# features and incurs lower costs.
|
|
1094
|
+
#
|
|
1092
1095
|
# * Use the `Delivery` log class only for delivering Lambda logs to
|
|
1093
1096
|
# store in Amazon S3 or Amazon Data Firehose. Log events in log
|
|
1094
1097
|
# groups in the Delivery class are kept in CloudWatch Logs for only
|
|
@@ -2814,7 +2817,11 @@ module Aws::CloudWatchLogs
|
|
|
2814
2817
|
# the specified log group class. If you omit this parameter, log
|
|
2815
2818
|
# groups of all classes can be returned.
|
|
2816
2819
|
#
|
|
2817
|
-
#
|
|
2820
|
+
# If you specify either `INFREQUENT_ACCESS` or `ESSENTIALS`, the
|
|
2821
|
+
# results include log groups in both the Infrequent Access and
|
|
2822
|
+
# Essentials log classes.
|
|
2823
|
+
#
|
|
2824
|
+
# Specifies the log group class for this log group. There are four
|
|
2818
2825
|
# classes:
|
|
2819
2826
|
#
|
|
2820
2827
|
# * The `Standard` log class supports all CloudWatch Logs features.
|
|
@@ -2822,6 +2829,9 @@ module Aws::CloudWatchLogs
|
|
|
2822
2829
|
# * The `Infrequent Access` log class supports a subset of CloudWatch
|
|
2823
2830
|
# Logs features and incurs lower costs.
|
|
2824
2831
|
#
|
|
2832
|
+
# * The `Essentials` log class supports a subset of CloudWatch Logs
|
|
2833
|
+
# features and incurs lower costs.
|
|
2834
|
+
#
|
|
2825
2835
|
# * Use the `Delivery` log class only for delivering Lambda logs to
|
|
2826
2836
|
# store in Amazon S3 or Amazon Data Firehose. Log events in log
|
|
2827
2837
|
# groups in the Delivery class are kept in CloudWatch Logs for only
|
|
@@ -6158,21 +6168,24 @@ module Aws::CloudWatchLogs
|
|
|
6158
6168
|
#
|
|
6159
6169
|
# @!attribute [rw] log_group_class
|
|
6160
6170
|
# This specifies the log group class for this log group. There are
|
|
6161
|
-
#
|
|
6171
|
+
# four classes:
|
|
6162
6172
|
#
|
|
6163
6173
|
# * The `Standard` log class supports all CloudWatch Logs features.
|
|
6164
6174
|
#
|
|
6165
6175
|
# * The `Infrequent Access` log class supports a subset of CloudWatch
|
|
6166
6176
|
# Logs features and incurs lower costs.
|
|
6167
6177
|
#
|
|
6178
|
+
# * The `Essentials` log class supports a subset of CloudWatch Logs
|
|
6179
|
+
# features and incurs lower costs.
|
|
6180
|
+
#
|
|
6168
6181
|
# * Use the `Delivery` log class only for delivering Lambda logs to
|
|
6169
6182
|
# store in Amazon S3 or Amazon Data Firehose. Log events in log
|
|
6170
6183
|
# groups in the Delivery class are kept in CloudWatch Logs for only
|
|
6171
6184
|
# one day. This log class doesn't offer rich CloudWatch Logs
|
|
6172
6185
|
# capabilities such as CloudWatch Logs Insights queries.
|
|
6173
6186
|
#
|
|
6174
|
-
# For details about the features supported by the Standard
|
|
6175
|
-
#
|
|
6187
|
+
# For details about the features supported by the Standard, Infrequent
|
|
6188
|
+
# Access, and Essentials classes, see [Log classes][1]
|
|
6176
6189
|
#
|
|
6177
6190
|
#
|
|
6178
6191
|
#
|
|
@@ -7959,6 +7972,36 @@ module Aws::CloudWatchLogs
|
|
|
7959
7972
|
# types are `FIELD_INDEX` and `FACET`. Field names within `Fields` and
|
|
7960
7973
|
# `FieldsV2` must be mutually exclusive.
|
|
7961
7974
|
#
|
|
7975
|
+
# **Retention policy**
|
|
7976
|
+
#
|
|
7977
|
+
# A retention policy must include the following attributes in a JSON
|
|
7978
|
+
# block:
|
|
7979
|
+
#
|
|
7980
|
+
# retentionInDays
|
|
7981
|
+
#
|
|
7982
|
+
# : The number of days to retain log events. Valid values are 30, 60,
|
|
7983
|
+
# 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557,
|
|
7984
|
+
# 2922, 3288, and 3653. To retain log events indefinitely, specify
|
|
7985
|
+
# the string `NEVER_EXPIRE`.
|
|
7986
|
+
#
|
|
7987
|
+
# enforcementMode
|
|
7988
|
+
#
|
|
7989
|
+
# : Specifies which log groups the policy applies to. Valid values are
|
|
7990
|
+
# `NEW_ONLY` and `RETROACTIVE`.
|
|
7991
|
+
#
|
|
7992
|
+
# `RETROACTIVE` applies the policy to every log group that matches
|
|
7993
|
+
# the selection criteria, including log groups that existed before
|
|
7994
|
+
# you created the policy.
|
|
7995
|
+
#
|
|
7996
|
+
# `NEW_ONLY` applies the policy only to log groups that are created
|
|
7997
|
+
# after you create the policy. Log groups that already existed when
|
|
7998
|
+
# you created the policy keep their own retention period.
|
|
7999
|
+
#
|
|
8000
|
+
# The following is an example of a retention policy document.
|
|
8001
|
+
#
|
|
8002
|
+
# `"policyDocument": "{"retentionInDays": 90, "enforcementMode":
|
|
8003
|
+
# "RETROACTIVE"}"`
|
|
8004
|
+
#
|
|
7962
8005
|
#
|
|
7963
8006
|
#
|
|
7964
8007
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html
|
|
@@ -7982,8 +8025,8 @@ module Aws::CloudWatchLogs
|
|
|
7982
8025
|
# in the account or a data source name and type combination.
|
|
7983
8026
|
#
|
|
7984
8027
|
# Specifying `selectionCriteria` is valid only when you specify
|
|
7985
|
-
# `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY
|
|
7986
|
-
# `TRANSFORMER_POLICY`for `policyType`.
|
|
8028
|
+
# `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY`,
|
|
8029
|
+
# `TRANSFORMER_POLICY`, or `RETENTION_POLICY` for `policyType`.
|
|
7987
8030
|
#
|
|
7988
8031
|
# * If `policyType` is `SUBSCRIPTION_FILTER_POLICY`, the only
|
|
7989
8032
|
# supported `selectionCriteria` filter is `LogGroupName NOT IN []`
|
|
@@ -8001,6 +8044,11 @@ module Aws::CloudWatchLogs
|
|
|
8001
8044
|
# can use either `LogGroupNamePrefix` by itself or `DataSourceName`
|
|
8002
8045
|
# and `DataSourceType` together.
|
|
8003
8046
|
#
|
|
8047
|
+
# * If `policyType` is `RETENTION_POLICY`, the only supported
|
|
8048
|
+
# `selectionCriteria` filter is `LogGroupNamePrefix`. If you omit
|
|
8049
|
+
# `selectionCriteria`, the retention policy applies to all log
|
|
8050
|
+
# groups in the account.
|
|
8051
|
+
#
|
|
8004
8052
|
# The `selectionCriteria` string can be up to 25KB in length. The
|
|
8005
8053
|
# length is determined by using its UTF-8 bytes.
|
|
8006
8054
|
#
|
data/sig/client.rbs
CHANGED
|
@@ -197,7 +197,7 @@ module Aws
|
|
|
197
197
|
log_group_name: ::String,
|
|
198
198
|
?kms_key_id: ::String,
|
|
199
199
|
?tags: Hash[::String, ::String],
|
|
200
|
-
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY"),
|
|
200
|
+
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS"),
|
|
201
201
|
?deletion_protection_enabled: bool
|
|
202
202
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
203
203
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
@@ -567,7 +567,7 @@ module Aws
|
|
|
567
567
|
?next_token: ::String,
|
|
568
568
|
?limit: ::Integer,
|
|
569
569
|
?include_linked_accounts: bool,
|
|
570
|
-
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY"),
|
|
570
|
+
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS"),
|
|
571
571
|
?log_group_identifiers: Array[::String]
|
|
572
572
|
) -> _DescribeLogGroupsResponseSuccess
|
|
573
573
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeLogGroupsResponseSuccess
|
|
@@ -975,7 +975,7 @@ module Aws
|
|
|
975
975
|
def list_aggregate_log_group_summaries: (
|
|
976
976
|
?account_identifiers: Array[::String],
|
|
977
977
|
?include_linked_accounts: bool,
|
|
978
|
-
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY"),
|
|
978
|
+
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS"),
|
|
979
979
|
?log_group_name_pattern: ::String,
|
|
980
980
|
?data_sources: Array[
|
|
981
981
|
{
|
|
@@ -1036,7 +1036,7 @@ module Aws
|
|
|
1036
1036
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatchLogs/Client.html#list_log_groups-instance_method
|
|
1037
1037
|
def list_log_groups: (
|
|
1038
1038
|
?log_group_name_pattern: ::String,
|
|
1039
|
-
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY"),
|
|
1039
|
+
?log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS"),
|
|
1040
1040
|
?include_linked_accounts: bool,
|
|
1041
1041
|
?account_identifiers: Array[::String],
|
|
1042
1042
|
?next_token: ::String,
|
data/sig/types.rbs
CHANGED
|
@@ -226,7 +226,7 @@ module Aws::CloudWatchLogs
|
|
|
226
226
|
attr_accessor log_group_name: ::String
|
|
227
227
|
attr_accessor kms_key_id: ::String
|
|
228
228
|
attr_accessor tags: ::Hash[::String, ::String]
|
|
229
|
-
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY")
|
|
229
|
+
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS")
|
|
230
230
|
attr_accessor deletion_protection_enabled: bool
|
|
231
231
|
SENSITIVE: []
|
|
232
232
|
end
|
|
@@ -655,7 +655,7 @@ module Aws::CloudWatchLogs
|
|
|
655
655
|
attr_accessor next_token: ::String
|
|
656
656
|
attr_accessor limit: ::Integer
|
|
657
657
|
attr_accessor include_linked_accounts: bool
|
|
658
|
-
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY")
|
|
658
|
+
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS")
|
|
659
659
|
attr_accessor log_group_identifiers: ::Array[::String]
|
|
660
660
|
SENSITIVE: []
|
|
661
661
|
end
|
|
@@ -1243,7 +1243,7 @@ module Aws::CloudWatchLogs
|
|
|
1243
1243
|
class ListAggregateLogGroupSummariesRequest
|
|
1244
1244
|
attr_accessor account_identifiers: ::Array[::String]
|
|
1245
1245
|
attr_accessor include_linked_accounts: bool
|
|
1246
|
-
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY")
|
|
1246
|
+
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS")
|
|
1247
1247
|
attr_accessor log_group_name_pattern: ::String
|
|
1248
1248
|
attr_accessor data_sources: ::Array[Types::DataSourceFilter]
|
|
1249
1249
|
attr_accessor group_by: ("DATA_SOURCE_NAME_TYPE_AND_FORMAT" | "DATA_SOURCE_NAME_AND_TYPE")
|
|
@@ -1312,7 +1312,7 @@ module Aws::CloudWatchLogs
|
|
|
1312
1312
|
|
|
1313
1313
|
class ListLogGroupsRequest
|
|
1314
1314
|
attr_accessor log_group_name_pattern: ::String
|
|
1315
|
-
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY")
|
|
1315
|
+
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS")
|
|
1316
1316
|
attr_accessor include_linked_accounts: bool
|
|
1317
1317
|
attr_accessor account_identifiers: ::Array[::String]
|
|
1318
1318
|
attr_accessor next_token: ::String
|
|
@@ -1461,7 +1461,7 @@ module Aws::CloudWatchLogs
|
|
|
1461
1461
|
attr_accessor kms_key_id: ::String
|
|
1462
1462
|
attr_accessor data_protection_status: ("ACTIVATED" | "DELETED" | "ARCHIVED" | "DISABLED")
|
|
1463
1463
|
attr_accessor inherited_properties: ::Array[("ACCOUNT_DATA_PROTECTION")]
|
|
1464
|
-
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY")
|
|
1464
|
+
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS")
|
|
1465
1465
|
attr_accessor log_group_arn: ::String
|
|
1466
1466
|
attr_accessor deletion_protection_enabled: bool
|
|
1467
1467
|
attr_accessor bearer_token_authentication_enabled: bool
|
|
@@ -1486,7 +1486,7 @@ module Aws::CloudWatchLogs
|
|
|
1486
1486
|
class LogGroupSummary
|
|
1487
1487
|
attr_accessor log_group_name: ::String
|
|
1488
1488
|
attr_accessor log_group_arn: ::String
|
|
1489
|
-
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY")
|
|
1489
|
+
attr_accessor log_group_class: ("STANDARD" | "INFREQUENT_ACCESS" | "DELIVERY" | "ESSENTIALS")
|
|
1490
1490
|
SENSITIVE: []
|
|
1491
1491
|
end
|
|
1492
1492
|
|