ReadonlygrantsCollection of grant methods for a LogGroup
ReadonlynodeThe tree node.
Static ReadonlyPROPERTY_Uniquely identifies this class.
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like new Role(), new Bucket(), etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be
different than the stack they were imported into.
The ARN of this log group
The name of this log group
A reference to a LogGroup resource.
ProtectedphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationThe stack in which this resource is defined.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
Create a new Metric Filter on this Log Group
Unique identifier for the construct in its parent
Properties for creating the MetricFilter
Create a new Log Stream for this Log Group
Unique identifier for the construct in its parent
Optionalprops: StreamOptionsProperties for creating the LogStream
Create a new Subscription Filter on this Log Group
Unique identifier for the construct in its parent
Properties for creating the SubscriptionFilter
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.
The policy statement to add
Create a new Transformer on this Log Group
Unique identifier for the construct in its parent
Properties for creating the Transformer
Override the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified
mechanism instead of the global default determined by the
@aws-cdk/core:defaultCrossStackReferences context key. This is useful for
selectively weakening specific references to avoid the "deadly embrace" problem
without changing the app-wide default.
The reference strength to use for this resource.
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).
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.
JSON field to extract (example: '$.myfield')
Namespace to emit the metric under
Name to emit the metric under
A Metric object representing the extracted metric
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Give the indicated permissions on this log group and all streams
[disable-awslint:no-grants]
Give permissions to read and filter events from this log group
The use of this method is discouraged. Please use grants.read() instead.
[disable-awslint:no-grants]
Give permissions to create and write to streams in this log group
The use of this method is discouraged. Please use grants.write() instead.
[disable-awslint:no-grants]
Public method to get the physical name of this log group
Physical name of log group
Creates a CloudWatch metric for this log group.
The name of the metric to create.
Optionalprops: MetricOptionsOptional. Additional properties to configure the metric.
A CloudWatch Metric object representing the specified metric for this log group.
This method creates a CloudWatch Metric object with predefined settings for the log group. It sets the namespace to 'AWS/Logs' and the statistic to 'Sum' by default.
The created metric is automatically associated with this log group using the attachTo method.
Common metric names for log groups include:
Creates a CloudWatch metric for the volume of incoming log data in bytes to this log group.
Optionalprops: MetricOptionsOptional. Configuration options for the metric.
A CloudWatch Metric object representing the IncomingBytes metric.
This method allows you to monitor the volume of data being ingested into the log group. It's useful for understanding the size of your logs, which can impact storage costs and help in identifying unexpectedly large log entries.
Example usage:
const logGroup = new logs.LogGroup(this, 'MyLogGroup');
logGroup.metricIncomingBytes().createAlarm(stack, 'IncomingBytesPerInstanceAlarm', {
threshold: 1,
evaluationPeriods: 1,
});
Creates a CloudWatch metric for the number of incoming log events to this log group.
Optionalprops: MetricOptionsOptional. Configuration options for the metric.
A CloudWatch Metric object representing the IncomingLogEvents metric.
This method allows you to monitor the rate at which log events are being ingested into the log group. It's useful for understanding the volume of logging activity and can help in capacity planning or detecting unusual spikes in logging.
Example usage:
const logGroup = new logs.LogGroup(this, 'MyLogGroup');
logGroup.metricIncomingLogEvents().createAlarm(stack, 'IncomingEventsPerInstanceAlarm', {
threshold: 1,
evaluationPeriods: 1,
});
Returns a string representation of this construct.
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
The mixins to apply
This construct for chaining
StaticfromImport an existing LogGroup given its ARN
StaticfromImport an existing LogGroup given its name
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
Construct for a compliant CloudWatch Log Group