Package software.amazon.awscdk.services.logs

Interface ILogGroup

All Superinterfaces:

IConstruct, software.constructs.IConstruct, IDependable, IResource, IResourceWithPolicy, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ILogGroup.Jsii$Default

All Known Implementing Classes:

ILogGroup.Jsii$Proxy, LogGroup

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.098Z")
@Stability(Stable)
public interface ILogGroup
extends software.amazon.jsii.JsiiSerializable, IResourceWithPolicy

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ILogGroup.Jsii$Default	Internal default implementation for ILogGroup.
static final class	ILogGroup.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
MetricFilter	addMetricFilter(String id, MetricFilterOptions props)	Create a new Metric Filter on this Log Group.
LogStream	addStream(String id)	Create a new Log Stream for this Log Group.
LogStream	addStream(String id, StreamOptions props)	Create a new Log Stream for this Log Group.
SubscriptionFilter	addSubscriptionFilter(String id, SubscriptionFilterOptions props)	Create a new Subscription Filter on this Log Group.
Metric	extractMetric(String jsonField, String metricNamespace, String metricName)	Extract a metric from structured log events in the LogGroup.
String	getLogGroupArn()	The ARN of this log group, with ':*' appended.
String	getLogGroupName()	The name of this log group.
Grant	grant(IGrantable grantee, @NotNull String... actions)	Give the indicated permissions on this log group and all streams.
Grant	grantWrite(IGrantable grantee)	Give permissions to write to create and write to streams in this log group.
String	logGroupPhysicalName()	Public method to get the physical name of this log group.

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy

addToResourcePolicy

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogGroupArn

@Stability(Stable)
@NotNull
String getLogGroupArn()

The ARN of this log group, with ':*' appended.

getLogGroupName

@Stability(Stable)
@NotNull
String getLogGroupName()

The name of this log group.

addMetricFilter

@Stability(Stable)
@NotNull
MetricFilter addMetricFilter(@NotNull
 String id,
 @NotNull
 MetricFilterOptions props)

Create a new Metric Filter on this Log Group.

Parameters:

id - Unique identifier for the construct in its parent. This parameter is required.

props - Properties for creating the MetricFilter. This parameter is required.

addStream

@Stability(Stable)
@NotNull
LogStream addStream(@NotNull
 String id,
 @Nullable
 StreamOptions props)

Create a new Log Stream for this Log Group.

Parameters:

id - Unique identifier for the construct in its parent. This parameter is required.

props - Properties for creating the LogStream.

addStream

@Stability(Stable)
@NotNull
LogStream addStream(@NotNull
 String id)

Create a new Log Stream for this Log Group.

Parameters:

id - Unique identifier for the construct in its parent. This parameter is required.

addSubscriptionFilter

@Stability(Stable)
@NotNull
SubscriptionFilter addSubscriptionFilter(@NotNull
 String id,
 @NotNull
 SubscriptionFilterOptions props)

Create a new Subscription Filter on this Log Group.

Parameters:

id - Unique identifier for the construct in its parent. This parameter is required.

props - Properties for creating the SubscriptionFilter. This parameter is required.

extractMetric

@Stability(Stable)
@NotNull
Metric extractMetric(@NotNull
 String jsonField,
 @NotNull
 String metricNamespace,
 @NotNull
 String metricName)

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:

jsonField - JSON field to extract (example: '$.myfield'). This parameter is required.

metricNamespace - Namespace to emit the metric under. This parameter is required.

metricName - Name to emit the metric under. This parameter is required.

Returns:

A Metric object representing the extracted metric

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantWrite

@Stability(Stable)
@NotNull
Grant grantWrite(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

logGroupPhysicalName

@Stability(Stable)
@NotNull
String logGroupPhysicalName()

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