Class: Aws::CloudWatchLogs::Types::LogGroup

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#arnString

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 :*.

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeInteger

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Returns:

  • (Integer)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#data_protection_statusString

Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#inherited_propertiesArray<String>

Displays all the properties that this log group has inherited from account-level settings.

Returns:

  • (Array<String>)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_arnString

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:

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_classString

This specifies the log group class for this log group. There are two classes:

  • The Standard log class supports all CloudWatch Logs features.

  • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_nameString

The name of the log group.

Returns:

  • (String)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#metric_filter_countInteger

The number of metric filters.

Returns:

  • (Integer)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  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, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

Returns:

  • (Integer)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end

#stored_bytesInteger

The number of bytes stored.

Returns:

  • (Integer)


3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 3401

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)
  SENSITIVE = []
  include Aws::Structure
end