Class: Aws::CloudWatchLogs::Types::LogGroup
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatchLogs::Types::LogGroup
- Defined in:
- gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb
Overview
Represents a log group.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the log group.
-
#bearer_token_authentication_enabled ⇒ Boolean
Indicates whether bearer token authentication is enabled for this log group.
-
#creation_time ⇒ Integer
The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
-
#data_protection_status ⇒ String
Displays whether this log group has a protection policy, or whether it had one in the past.
-
#deletion_protection_enabled ⇒ Boolean
Indicates whether deletion protection is enabled for this log group.
-
#inherited_properties ⇒ Array<String>
Displays all the properties that this log group has inherited from account-level settings.
-
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
-
#log_group_arn ⇒ String
The Amazon Resource Name (ARN) of the log group.
-
#log_group_class ⇒ String
This specifies the log group class for this log group.
-
#log_group_name ⇒ String
The name of the log group.
-
#metric_filter_count ⇒ Integer
The number of metric filters.
-
#retention_in_days ⇒ Integer
The number of days to retain the log events in the specified log group.
-
#retention_policy_name ⇒ String
The name of the account-level retention policy that determines the retention period of this log group.
-
#stored_bytes ⇒ Integer
The number of bytes stored.
Instance Attribute Details
#arn ⇒ String
The Amazon Resource Name (ARN) of the log group. This version of the
ARN includes a trailing :* after the log group name.
Use this version to refer to the ARN in IAM policies when specifying
permissions for most API actions. The exception is when specifying
permissions for TagResource, UntagResource, and
ListTagsForResource. The permissions for those three actions
require the ARN version that doesn't include a trailing :*.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#bearer_token_authentication_enabled ⇒ Boolean
Indicates whether bearer token authentication is enabled for this log group. When enabled, bearer token authentication is allowed on operations until it is explicitly disabled.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#creation_time ⇒ Integer
The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#data_protection_status ⇒ String
Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#deletion_protection_enabled ⇒ Boolean
Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#inherited_properties ⇒ Array<String>
Displays all the properties that this log group has inherited from account-level settings.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#kms_key_id ⇒ String
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#log_group_arn ⇒ String
The Amazon Resource Name (ARN) of the log group. This version of the
ARN doesn't include a trailing :* after the log group name.
Use this version to refer to the ARN in the following situations:
In the
logGroupIdentifierinput field in many CloudWatch Logs APIs.In the
resourceArnfield in tagging APIsIn IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#log_group_class ⇒ String
This specifies the log group class for this log group. There are four classes:
The
Standardlog class supports all CloudWatch Logs features.The
Infrequent Accesslog class supports a subset of CloudWatch Logs features and incurs lower costs.The
Essentialslog class supports a subset of CloudWatch Logs features and incurs lower costs.Use the
Deliverylog class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
For details about the features supported by the Standard, Infrequent Access, and Essentials classes, see Log classes
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#log_group_name ⇒ String
The name of the log group.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#metric_filter_count ⇒ Integer
The number of metric filters.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#retention_in_days ⇒ Integer
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, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.
To set a log group so that its log events do not expire, use DeleteRetentionPolicy.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#retention_policy_name ⇒ String
The name of the account-level retention policy that determines the
retention period of this log group. This field is returned only when
an account-level retention policy applies to the log group. When it
is returned, retentionInDays shows the retention period from that
policy instead of the retention period set on the log group. If the
policy specifies that log events never expire, retentionInDays is
not returned.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |
#stored_bytes ⇒ Integer
The number of bytes stored.
6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 |
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 6240 class LogGroup < Struct.new( :log_group_name, :creation_time, :retention_in_days, :metric_filter_count, :arn, :stored_bytes, :kms_key_id, :data_protection_status, :inherited_properties, :log_group_class, :log_group_arn, :deletion_protection_enabled, :bearer_token_authentication_enabled, :retention_policy_name) SENSITIVE = [] include Aws::Structure end |