Package 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:

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

Enclosing interface:

ILogGroup

@Internal
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

ILogGroup.Jsii$Default, ILogGroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy

IResourceWithPolicy.Jsii$Default, IResourceWithPolicy.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final MetricFilter	addMetricFilter(String id, MetricFilterOptions props)	Create a new Metric Filter on this Log Group.
final LogStream	addStream(String id)	Create a new Log Stream for this Log Group.
final LogStream	addStream(String id, StreamOptions props)	Create a new Log Stream for this Log Group.
final SubscriptionFilter	addSubscriptionFilter(String id, SubscriptionFilterOptions props)	Create a new Subscription Filter on this Log Group.
final AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement)	Add a statement to the resource's resource policy.
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final Metric	extractMetric(String jsonField, String metricNamespace, String metricName)	Extract a metric from structured log events in the LogGroup.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final String	getLogGroupArn()	The ARN of this log group, with ':*' appended.
final String	getLogGroupName()	The name of this log group.
final software.constructs.Node	getNode()	The tree node.
final Stack	getStack()	The stack in which this resource is defined.
final Grant	grant(IGrantable grantee, @NotNull String... actions)	Give the indicated permissions on this log group and all streams.
final Grant	grantRead(IGrantable grantee)	Give permissions to read from this log group and streams.
final Grant	grantWrite(IGrantable grantee)	Give permissions to write to create and write to streams in this log group.
final String	logGroupPhysicalName()	Public method to get the physical name of this log group.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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 ILogGroup.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IResourceWithPolicy.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
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 ILogGroup.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IResourceWithPolicy.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface ILogGroup.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IResourceWithPolicy.Jsii$Default

getLogGroupArn

@Stability(Stable)
@NotNull
public final 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

@Stability(Stable)
@NotNull
public final String getLogGroupName()

The name of this log group.

Specified by:

getLogGroupName in interface ILogGroup

Specified by:

getLogGroupName in interface ILogGroup.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 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 ILogGroup.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResourceWithPolicy.Jsii$Default

Parameters:

policy - This parameter is required.

addToResourcePolicy

@Stability(Stable)
@NotNull
public final AddToResourcePolicyResult addToResourcePolicy(@NotNull
 PolicyStatement statement)

Add a statement to the resource's resource policy.

Specified by:

addToResourcePolicy in interface ILogGroup.Jsii$Default

Specified by:

addToResourcePolicy in interface IResourceWithPolicy

Specified by:

addToResourcePolicy in interface IResourceWithPolicy.Jsii$Default

Parameters:

statement - This parameter is required.

addMetricFilter

@Stability(Stable)
@NotNull
public final MetricFilter addMetricFilter(@NotNull
 String id,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final LogStream addStream(@NotNull
 String id,
 @Nullable
 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

@Stability(Stable)
@NotNull
public final LogStream addStream(@NotNull
 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

@Stability(Stable)
@NotNull
public final SubscriptionFilter addSubscriptionFilter(@NotNull
 String id,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Metric extractMetric(@NotNull
 String jsonField,
 @NotNull
 String metricNamespace,
 @NotNull
 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

@Stability(Stable)
@NotNull
public final Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull 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.

grantRead

@Stability(Stable)
@NotNull
public final Grant grantRead(@NotNull
 IGrantable grantee)

Give permissions to read from this log group and streams.

Specified by:

grantRead in interface ILogGroup

Specified by:

grantRead in interface ILogGroup.Jsii$Default

Parameters:

grantee - This parameter is required.

grantWrite

@Stability(Stable)
@NotNull
public final Grant grantWrite(@NotNull
 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

@Stability(Stable)
@NotNull
public final 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