class Amazonite::CloudWatchLogs::LogGroup

Overview

Represents a log group.

Included Modules

Defined in:

cloudwatch_logs/log_group.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(log_group_name : String | Nil = nil, creation_time : Int64 | Nil = nil, retention_in_days : Int32 | Nil = nil, metric_filter_count : Int32 | Nil = nil, arn : String | Nil = nil, stored_bytes : Int64 | Nil = nil, kms_key_id : String | Nil = nil, data_protection_status : DataProtectionStatus | Nil = nil, inherited_properties : Array(InheritedProperty) | Nil = nil, log_group_class : LogGroupClass | Nil = nil, log_group_arn : String | Nil = nil, deletion_protection_enabled : Bool | Nil = nil, bearer_token_authentication_enabled : Bool | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def arn : String | Nil #

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


[View source]
def arn=(arn : String | Nil) #

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


[View source]
def bearer_token_authentication_enabled : Bool | Nil #

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.


[View source]
def bearer_token_authentication_enabled=(bearer_token_authentication_enabled : Bool | Nil) #

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.


[View source]
def creation_time : Int64 | Nil #

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


[View source]
def creation_time=(creation_time : Int64 | Nil) #

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


[View source]
def data_protection_status : DataProtectionStatus | Nil #

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


[View source]
def data_protection_status=(data_protection_status : DataProtectionStatus | Nil) #

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


[View source]
def deletion_protection_enabled : Bool | Nil #

Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.


[View source]
def deletion_protection_enabled=(deletion_protection_enabled : Bool | Nil) #

Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def inherited_properties : Array(InheritedProperty) | Nil #

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


[View source]
def inherited_properties=(inherited_properties : Array(InheritedProperty) | Nil) #

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


[View source]
def kms_key_id : String | Nil #

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


[View source]
def kms_key_id=(kms_key_id : String | Nil) #

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


[View source]
def log_group_arn : String | Nil #

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:


[View source]
def log_group_arn=(log_group_arn : String | Nil) #

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:


[View source]
def log_group_class : LogGroupClass | Nil #

This specifies the log group class for this log group. There are three 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.

  • Use the Delivery log 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 and Infrequent Access classes, see Log classes


[View source]
def log_group_class=(log_group_class : LogGroupClass | Nil) #

This specifies the log group class for this log group. There are three 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.

  • Use the Delivery log 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 and Infrequent Access classes, see Log classes


[View source]
def log_group_name : String | Nil #

The name of the log group.


[View source]
def log_group_name=(log_group_name : String | Nil) #

The name of the log group.


[View source]
def metric_filter_count : Int32 | Nil #

The number of metric filters.


[View source]
def metric_filter_count=(metric_filter_count : Int32 | Nil) #

The number of metric filters.


[View source]
def retention_in_days : Int32 | Nil #

[View source]
def retention_in_days=(retention_in_days : Int32 | Nil) #

[View source]
def stored_bytes : Int64 | Nil #

The number of bytes stored.


[View source]
def stored_bytes=(stored_bytes : Int64 | Nil) #

The number of bytes stored.


[View source]
def validate! : Nil #

[View source]