ILogGroup

class aws_cdk.aws_logs.ILogGroup(*args, **kwargs)

Bases: IResourceWithPolicy, Protocol

Methods

add_metric_filter(id, *, filter_pattern, metric_name, metric_namespace, default_value=None, dimensions=None, filter_name=None, metric_value=None, unit=None)

Create a new Metric Filter on this Log Group.

Parameters:

  • id (str) – Unique identifier for the construct in its parent.

  • filter_pattern (IFilterPattern) – Pattern to search for log events.

  • metric_name (str) – The name of the metric to emit.

  • metric_namespace (str) – The namespace of the metric to emit.

  • default_value (Union[int, float, None]) – The value to emit if the pattern does not match a particular event. Default: No metric emitted.

  • dimensions (Optional[Mapping[str, str]]) – The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Default: - No dimensions attached to metrics.

  • filter_name (Optional[str]) – The name of the metric filter. Default: - Cloudformation generated name.

  • metric_value (Optional[str]) – The value to emit for the metric. Can either be a literal number (typically “1”), or the name of a field in the structure to take the value from the matched event. If you are using a field value, the field value must have been matched using the pattern. If you want to specify a field from a matched JSON structure, use ‘$.fieldName’, and make sure the field is in the pattern (if only as ‘$.fieldName = *’). If you want to specify a field from a matched space-delimited structure, use ‘$fieldName’. Default: “1”

  • unit (Optional[Unit]) – The unit to assign to the metric. Default: - No unit attached to metrics.

Return type:

MetricFilter

add_stream(id, *, log_stream_name=None)

Create a new Log Stream for this Log Group.

Parameters:

  • id (str) – Unique identifier for the construct in its parent.

  • log_stream_name (Optional[str]) – The name of the log stream to create. The name must be unique within the log group. Default: Automatically generated

Return type:

LogStream

add_subscription_filter(id, *, destination, filter_pattern, filter_name=None)

Create a new Subscription Filter on this Log Group.

Parameters:

  • id (str) – Unique identifier for the construct in its parent.

  • destination (ILogSubscriptionDestination) – The destination to send the filtered events to. For example, a Kinesis stream or a Lambda function.

  • filter_pattern (IFilterPattern) – Log events matching this pattern will be sent to the destination.

  • filter_name (Optional[str]) – The name of the subscription filter. Default: Automatically generated

Return type:

SubscriptionFilter

add_to_resource_policy(statement)

Add a statement to the resource’s resource policy.

Parameters:

statement (PolicyStatement) –

Return type:

AddToResourcePolicyResult

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

extract_metric(json_field, metric_namespace, metric_name)

Extract a metric from structured log events in the LogGroup.

Creates a MetricFilter on this LogGroup that will extract the value of the indicated JSON field in all records where it occurs.

The metric will be available in CloudWatch Metrics under the indicated namespace and name.

Parameters:

  • json_field (str) – JSON field to extract (example: ‘$.myfield’).

  • metric_namespace (str) – Namespace to emit the metric under.

  • metric_name (str) – Name to emit the metric under.

Return type:

Metric

Returns:

A Metric object representing the extracted metric

grant(grantee, *actions)

Give the indicated permissions on this log group and all streams.

Parameters:
Return type:

Grant

grant_read(grantee)

Give permissions to read from this log group and streams.

Parameters:

grantee (IGrantable) –

Return type:

Grant

grant_write(grantee)

Give permissions to write to create and write to streams in this log group.

Parameters:

grantee (IGrantable) –

Return type:

Grant

log_group_physical_name()

Public method to get the physical name of this log group.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

log_group_arn

*’ appended.

Attribute:

true

Type:

The ARN of this log group, with ‘

log_group_name

The name of this log group.

Attribute:

true

node

The tree node.

stack

The stack in which this resource is defined.