software.amazon.awscdk.services.logs

Class LogGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.logs.LogGroup

All Implemented Interfaces:

IConstruct, IDependable, IResource, IResourceWithPolicy, ILogGroup

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:19.665Z")
public class LogGroup
extends Resource
implements ILogGroup

Define a CloudWatch Log Group.

Example:

 import software.amazon.awscdk.services.logs.*;
 LogGroup logGroup = new LogGroup(this, "Log Group");
 Bucket logBucket = new Bucket(this, "S3 Bucket");
 EmrContainersStartJobRun.Builder.create(this, "EMR Containers Start Job Run")
         .virtualCluster(VirtualClusterInput.fromVirtualClusterId("de92jdei2910fwedz"))
         .releaseLabel(ReleaseLabel.EMR_6_2_0)
         .jobDriver(JobDriver.builder()
                 .sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
                         .entryPoint(TaskInput.fromText("local:///usr/lib/spark/examples/src/main/python/pi.py"))
                         .sparkSubmitParameters("--conf spark.executor.instances=2 --conf spark.executor.memory=2G --conf spark.executor.cores=2 --conf spark.driver.cores=1")
                         .build())
                 .build())
         .monitoring(Monitoring.builder()
                 .logGroup(logGroup)
                 .logBucket(logBucket)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

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
protected	LogGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LogGroup(software.amazon.jsii.JsiiObjectRef objRef)
	LogGroup(software.constructs.Construct scope, java.lang.String id)
	LogGroup(software.constructs.Construct scope, java.lang.String id, LogGroupProps props)

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.
AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Adds a statement to the resource policy associated with 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.
static ILogGroup	fromLogGroupArn(software.constructs.Construct scope, java.lang.String id, java.lang.String logGroupArn) Import an existing LogGroup given its ARN.
static ILogGroup	fromLogGroupName(software.constructs.Construct scope, java.lang.String id, java.lang.String logGroupName) Import an existing LogGroup given its name.
java.lang.String	getLogGroupArn() The ARN of this log group.
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 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 class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Constructor Detail

LogGroup

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

LogGroup

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

LogGroup

public LogGroup(software.constructs.Construct scope,
                java.lang.String id,
                LogGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

LogGroup

public LogGroup(software.constructs.Construct scope,
                java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromLogGroupArn

public static ILogGroup fromLogGroupArn(software.constructs.Construct scope,
                                        java.lang.String id,
                                        java.lang.String logGroupArn)

Import an existing LogGroup given its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

logGroupArn - This parameter is required.

fromLogGroupName

public static ILogGroup fromLogGroupName(software.constructs.Construct scope,
                                         java.lang.String id,
                                         java.lang.String logGroupName)

Import an existing LogGroup given its name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

logGroupName - This parameter is required.

addMetricFilter

public MetricFilter addMetricFilter(java.lang.String id,
                                    MetricFilterOptions props)

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

public LogStream addStream(java.lang.String id,
                           StreamOptions props)

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

public LogStream addStream(java.lang.String id)

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

public SubscriptionFilter addSubscriptionFilter(java.lang.String id,
                                                SubscriptionFilterOptions props)

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.

addToResourcePolicy

public AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)

Adds a statement to the resource policy associated with this log group.

A resource policy will be automatically created upon the first call to addToResourcePolicy.

Any ARN Principals inside of the statement will be converted into AWS Account ID strings because CloudWatch Logs Resource Policies do not accept ARN principals.

Specified by:

addToResourcePolicy in interface IResourceWithPolicy

Parameters:

statement - The policy statement to add. This parameter is required.

extractMetric

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

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

public Grant grant(IGrantable grantee,
                   java.lang.String... actions)

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

public Grant grantWrite(IGrantable grantee)

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

Specified by:

grantWrite in interface ILogGroup

Parameters:

grantee - This parameter is required.

logGroupPhysicalName

public java.lang.String logGroupPhysicalName()

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

Specified by:

logGroupPhysicalName in interface ILogGroup

Returns:

Physical name of log group

getLogGroupArn

public java.lang.String getLogGroupArn()

The ARN of this log group.

Specified by:

getLogGroupArn in interface ILogGroup

getLogGroupName

public java.lang.String getLogGroupName()

The name of this log group.

Specified by:

getLogGroupName in interface ILogGroup