software.amazon.awscdk.services.logs

Interface ILogGroup.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, ILogGroup, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ILogGroup.Jsii$Proxy

Enclosing interface:

ILogGroup

@Internal
public static interface ILogGroup.Jsii$Default
extends ILogGroup, IResource.Jsii$Default

Internal default implementation for ILogGroup.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.logs.ILogGroup

ILogGroup.Jsii$Default, ILogGroup.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default MetricFilter	addMetricFilter(String id, MetricFilterOptions props) (experimental) Create a new Metric Filter on this Log Group.
default LogStream	addStream(String id, StreamOptions props) (experimental) Create a new Log Stream for this Log Group.
default SubscriptionFilter	addSubscriptionFilter(String id, SubscriptionFilterOptions props) (experimental) Create a new Subscription Filter on this Log Group.
default Metric	extractMetric(String jsonField, String metricNamespace, String metricName) (experimental) Extract a metric from structured log events in the LogGroup.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default String	getLogGroupArn() (experimental) The ARN of this log group, with ':*' appended.
default String	getLogGroupName() (experimental) The name of this log group.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default Grant	grant(IGrantable grantee, String... actions) (experimental) Give the indicated permissions on this log group and all streams.
default Grant	grantWrite(IGrantable grantee) (experimental) Give permissions to write to create and write to streams in this log group.

Methods inherited from interface software.amazon.awscdk.services.logs.ILogGroup

addStream

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) 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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getLogGroupArn

@Stability(value=Experimental)
 @NotNull
default String getLogGroupArn()

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

Specified by:

getLogGroupArn in interface ILogGroup

getLogGroupName

@Stability(value=Experimental)
 @NotNull
default String getLogGroupName()

(experimental) The name of this log group.

Specified by:

getLogGroupName in interface ILogGroup

addMetricFilter

@Stability(value=Experimental)
 @NotNull
default MetricFilter addMetricFilter(@NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              MetricFilterOptions props)

(experimental) Create a new Metric Filter on this Log Group.

Specified by:

addMetricFilter in interface ILogGroup

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(value=Experimental)
 @NotNull
default LogStream addStream(@NotNull
                                                                     String id,
                                                                     @Nullable
                                                                     StreamOptions props)

(experimental) Create a new Log Stream for this Log Group.

Specified by:

addStream in interface ILogGroup

Parameters:

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

props - Properties for creating the LogStream.

addSubscriptionFilter

@Stability(value=Experimental)
 @NotNull
default SubscriptionFilter addSubscriptionFilter(@NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          SubscriptionFilterOptions props)

(experimental) Create a new Subscription Filter on this Log Group.

Specified by:

addSubscriptionFilter in interface ILogGroup

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(value=Experimental)
 @NotNull
default Metric extractMetric(@NotNull
                                                                      String jsonField,
                                                                      @NotNull
                                                                      String metricNamespace,
                                                                      @NotNull
                                                                      String metricName)

(experimental) 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.

Specified by:

extractMetric in interface ILogGroup

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(value=Experimental)
 @NotNull
default Grant grant(@NotNull
                                                             IGrantable grantee,
                                                             @NotNull
                                                             String... actions)

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

Specified by:

grant in interface ILogGroup

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantWrite

@Stability(value=Experimental)
 @NotNull
default Grant grantWrite(@NotNull
                                                                  IGrantable grantee)

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

Specified by:

grantWrite in interface ILogGroup

Parameters:

grantee - This parameter is required.