Skip to content

LogGroup

Source code in docs_src/capo_cloudwatch_logs/types/log_group.py
class LogGroup(TypedDict, closed=True):
    log_group_name: NotRequired[
        "capo_cloudwatch_logs.types.log_group_name.LogGroupName"
    ]
    """<p>The name of the log group.</p>"""
    creation_time: NotRequired["capo_cloudwatch_logs.types.timestamp.Timestamp"]
    """<p>The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>"""
    retention_in_days: NotRequired["capo_cloudwatch_logs.types.days.Days"]
    metric_filter_count: NotRequired[
        "capo_cloudwatch_logs.types.filter_count.FilterCount"
    ]
    """<p>The number of metric filters.</p>"""
    arn: NotRequired["capo_cloudwatch_logs.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing <code>:*</code> after the log group name. </p> <p>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 <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>. The permissions for those three actions require the ARN version that doesn't include a trailing <code>:*</code>.</p>"""
    stored_bytes: NotRequired["capo_cloudwatch_logs.types.stored_bytes.StoredBytes"]
    """<p>The number of bytes stored.</p>"""
    kms_key_id: NotRequired["capo_cloudwatch_logs.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.</p>"""
    data_protection_status: NotRequired[
        "capo_cloudwatch_logs.types.data_protection_status.DataProtectionStatus"
    ]
    """<p>Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>.</p>"""
    inherited_properties: NotRequired[
        "capo_cloudwatch_logs.types.inherited_properties.InheritedProperties"
    ]
    """<p>Displays all the properties that this log group has inherited from account-level settings.</p>"""
    log_group_class: NotRequired[
        "capo_cloudwatch_logs.types.log_group_class.LogGroupClass"
    ]
    """<p>This specifies the log group class for this log group. There are three classes:</p> <ul> <li> <p>The <code>Standard</code> log class supports all CloudWatch Logs features.</p> </li> <li> <p>The <code>Infrequent Access</code> log class supports a subset of CloudWatch Logs features and incurs lower costs.</p> </li> <li> <p>Use the <code>Delivery</code> 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.</p> </li> </ul> <p>For details about the features supported by the Standard and Infrequent Access classes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a> </p>"""
    log_group_arn: NotRequired["capo_cloudwatch_logs.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing <code>:*</code> after the log group name. </p> <p>Use this version to refer to the ARN in the following situations:</p> <ul> <li> <p>In the <code>logGroupIdentifier</code> input field in many CloudWatch Logs APIs.</p> </li> <li> <p>In the <code>resourceArn</code> field in tagging APIs</p> </li> <li> <p>In IAM policies, when specifying permissions for <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>, <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>, and <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>.</p> </li> </ul>"""
    deletion_protection_enabled: NotRequired[
        "capo_cloudwatch_logs.types.deletion_protection_enabled.DeletionProtectionEnabled"
    ]
    """<p>Indicates whether deletion protection is enabled for this log group. When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.</p>"""
    bearer_token_authentication_enabled: NotRequired[
        "capo_cloudwatch_logs.types.bearer_token_authentication_enabled.BearerTokenAuthenticationEnabled"
    ]
    """<p>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.</p>"""

arn instance-attribute

arn: NotRequired[Arn]

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

bearer_token_authentication_enabled instance-attribute

bearer_token_authentication_enabled: NotRequired[BearerTokenAuthenticationEnabled]

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.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

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

data_protection_status instance-attribute

data_protection_status: NotRequired[DataProtectionStatus]

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

deletion_protection_enabled instance-attribute

deletion_protection_enabled: NotRequired[DeletionProtectionEnabled]

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

inherited_properties instance-attribute

inherited_properties: NotRequired[InheritedProperties]

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

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

log_group_arn instance-attribute

log_group_arn: NotRequired[Arn]

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:

log_group_class instance-attribute

log_group_class: NotRequired[LogGroupClass]

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

log_group_name instance-attribute

log_group_name: NotRequired[LogGroupName]

The name of the log group.

metric_filter_count instance-attribute

metric_filter_count: NotRequired[FilterCount]

The number of metric filters.

retention_in_days instance-attribute

retention_in_days: NotRequired[Days]

stored_bytes instance-attribute

stored_bytes: NotRequired[StoredBytes]

The number of bytes stored.