software.amazon.awscdk.services.logs

Class ILogGroup.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.logs.ILogGroup.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IResourceWithPolicy, IResourceWithPolicy.Jsii$Default, ILogGroup, ILogGroup.Jsii$Default

Enclosing interface:

ILogGroup

public static final class ILogGroup.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ILogGroup.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

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) Add a statement to the resource's resource policy.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
Metric	extractMetric(java.lang.String jsonField, java.lang.String metricNamespace, java.lang.String metricName) Extract a metric from structured log events in the LogGroup.
ResourceEnvironment	getEnv() The environment this resource belongs to.
java.lang.String	getLogGroupArn() The ARN of this log group, with ':*' appended.
java.lang.String	getLogGroupName() The name of this log group.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.
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 class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IResourceWithPolicy.Jsii$Default

Specified by:

getNode in interface ILogGroup.Jsii$Default

getEnv

public final ResourceEnvironment getEnv()

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

Specified by:

getEnv in interface IResourceWithPolicy.Jsii$Default

Specified by:

getEnv in interface ILogGroup.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IResourceWithPolicy.Jsii$Default

Specified by:

getStack in interface ILogGroup.Jsii$Default

getLogGroupArn

public final java.lang.String getLogGroupArn()

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

Specified by:

getLogGroupArn in interface ILogGroup

Specified by:

getLogGroupArn in interface ILogGroup.Jsii$Default

getLogGroupName

public final java.lang.String getLogGroupName()

The name of this log group.

Specified by:

getLogGroupName in interface ILogGroup

Specified by:

getLogGroupName in interface ILogGroup.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResourceWithPolicy.Jsii$Default

Specified by:

applyRemovalPolicy in interface ILogGroup.Jsii$Default

Parameters:

policy - This parameter is required.

addToResourcePolicy

public final AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)

Add a statement to the resource's resource policy.

Specified by:

addToResourcePolicy in interface IResourceWithPolicy

Specified by:

addToResourcePolicy in interface IResourceWithPolicy.Jsii$Default

Specified by:

addToResourcePolicy in interface ILogGroup.Jsii$Default

Parameters:

statement - This parameter is required.

addMetricFilter

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

Create a new Metric Filter on this Log Group.

Specified by:

addMetricFilter in interface ILogGroup

Specified by:

addMetricFilter in interface ILogGroup.Jsii$Default

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

Create a new Log Stream for this Log Group.

Specified by:

addStream in interface ILogGroup

Specified by:

addStream in interface ILogGroup.Jsii$Default

Parameters:

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

props - Properties for creating the LogStream.

addStream

public final 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 final SubscriptionFilter addSubscriptionFilter(java.lang.String id,
                                                      SubscriptionFilterOptions props)

Create a new Subscription Filter on this Log Group.

Specified by:

addSubscriptionFilter in interface ILogGroup

Specified by:

addSubscriptionFilter in interface ILogGroup.Jsii$Default

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

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

Specified by:

extractMetric in interface ILogGroup.Jsii$Default

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 final 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

Specified by:

grant in interface ILogGroup.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantWrite

public final Grant grantWrite(IGrantable grantee)

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

Specified by:

grantWrite in interface ILogGroup

Specified by:

grantWrite in interface ILogGroup.Jsii$Default

Parameters:

grantee - This parameter is required.

logGroupPhysicalName

public final java.lang.String logGroupPhysicalName()

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

Specified by:

logGroupPhysicalName in interface ILogGroup

Specified by:

logGroupPhysicalName in interface ILogGroup.Jsii$Default