software.amazon.awscdk.services.logs

Interface ILogGroup

All Superinterfaces:

IConstruct, IDependable, IResource, IResourceWithPolicy

All Known Subinterfaces:

ILogGroup.Jsii$Default

All Known Implementing Classes:

ILogGroup.Jsii$Proxy, LogGroup

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.348Z")
public interface ILogGroup
extends IResourceWithPolicy

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
MetricFilter	addMetricFilter(java.lang.String id, MetricFilterOptions props) Create a new Metric Filter on this Log Group.
LogStream	addStream(java.lang.String id) Create a new Log Stream for this Log Group.
LogStream	addStream(java.lang.String id, StreamOptions props) Create a new Log Stream for this Log Group.
SubscriptionFilter	addSubscriptionFilter(java.lang.String id, SubscriptionFilterOptions props) Create a new Subscription Filter on this Log Group.
Metric	extractMetric(java.lang.String jsonField, java.lang.String metricNamespace, java.lang.String metricName) Extract a metric from structured log events in the LogGroup.
java.lang.String	getLogGroupArn() The ARN of this log group, with ':*' appended.
java.lang.String	getLogGroupName() The name of this log group.
Grant	grant(IGrantable grantee, java.lang.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.
java.lang.String	logGroupPhysicalName() Public method to get the physical name of this log group.

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

addToResourcePolicy

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Method Detail

getLogGroupArn

java.lang.String getLogGroupArn()

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

getLogGroupName

java.lang.String getLogGroupName()

The name of this log group.

addMetricFilter

MetricFilter addMetricFilter(java.lang.String id,
                             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

LogStream addStream(java.lang.String id,
                    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

LogStream addStream(java.lang.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

SubscriptionFilter addSubscriptionFilter(java.lang.String id,
                                         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

Metric extractMetric(java.lang.String jsonField,
                     java.lang.String metricNamespace,
                     java.lang.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

Grant grant(IGrantable grantee,
            java.lang.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

Grant grantWrite(IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

logGroupPhysicalName

java.lang.String logGroupPhysicalName()

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