software.amazon.awscdk.services.logs

Class LogGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.logs.LogGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.738Z")
 @Stability(value=Experimental)
public class LogGroup
extends Resource
implements ILogGroup

(experimental) Define a CloudWatch Log Group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogGroup.Builder (experimental) A fluent builder for LogGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

ILogGroup.Jsii$Default, ILogGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	LogGroup(software.constructs.Construct scope, String id)
	LogGroup(software.constructs.Construct scope, String id, LogGroupProps props)
protected	LogGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LogGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
MetricFilter	addMetricFilter(String id, MetricFilterOptions props) (experimental) Create a new Metric Filter on this Log Group.
LogStream	addStream(String id) (experimental) Create a new Log Stream for this Log Group.
LogStream	addStream(String id, StreamOptions props) (experimental) Create a new Log Stream for this Log Group.
SubscriptionFilter	addSubscriptionFilter(String id, SubscriptionFilterOptions props) (experimental) Create a new Subscription Filter on this Log Group.
Metric	extractMetric(String jsonField, String metricNamespace, String metricName) (experimental) Extract a metric from structured log events in the LogGroup.
static ILogGroup	fromLogGroupArn(software.constructs.Construct scope, String id, String logGroupArn) (experimental) Import an existing LogGroup given its ARN.
static ILogGroup	fromLogGroupName(software.constructs.Construct scope, String id, String logGroupName) (experimental) Import an existing LogGroup given its name.
String	getLogGroupArn() (experimental) The ARN of this log group.
String	getLogGroupName() (experimental) The name of this log group.
Grant	grant(IGrantable grantee, String... actions) (experimental) Give the indicated permissions on this log group and all streams.
Grant	grantWrite(IGrantable grantee) (experimental) Give permissions to create and write to streams in this log group.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LogGroup

protected LogGroup(software.amazon.jsii.JsiiObjectRef objRef)

LogGroup

protected LogGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LogGroup

@Stability(value=Experimental)
public LogGroup(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               LogGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

LogGroup

@Stability(value=Experimental)
public LogGroup(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromLogGroupArn

@Stability(value=Experimental)
 @NotNull
public static ILogGroup fromLogGroupArn(@NotNull
                                                                                 software.constructs.Construct scope,
                                                                                 @NotNull
                                                                                 String id,
                                                                                 @NotNull
                                                                                 String logGroupArn)

(experimental) Import an existing LogGroup given its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

logGroupArn - This parameter is required.

fromLogGroupName

@Stability(value=Experimental)
 @NotNull
public static ILogGroup fromLogGroupName(@NotNull
                                                                                  software.constructs.Construct scope,
                                                                                  @NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  String logGroupName)

(experimental) Import an existing LogGroup given its name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

logGroupName - This parameter is required.

addMetricFilter

@Stability(value=Experimental)
 @NotNull
public 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
public 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.

addStream

@Stability(value=Experimental)
 @NotNull
public LogStream addStream(@NotNull
                                                                    String id)

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

addSubscriptionFilter

@Stability(value=Experimental)
 @NotNull
public 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
public 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
public 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
public Grant grantWrite(@NotNull
                                                                 IGrantable grantee)

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

Specified by:

grantWrite in interface ILogGroup

Parameters:

grantee - This parameter is required.

getLogGroupArn

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

(experimental) The ARN of this log group.

Specified by:

getLogGroupArn in interface ILogGroup

getLogGroupName

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

(experimental) The name of this log group.

Specified by:

getLogGroupName in interface ILogGroup