Class 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
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$ProxyNested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.logs.ILogGroup
ILogGroup.Jsii$Default, ILogGroup.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy
IResourceWithPolicy.Jsii$Default, IResourceWithPolicy.Jsii$Proxy -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal MetricFilteraddMetricFilter(String id, MetricFilterOptions props) Create a new Metric Filter on this Log Group.final LogStreamCreate a new Log Stream for this Log Group.final LogStreamaddStream(String id, StreamOptions props) Create a new Log Stream for this Log Group.final SubscriptionFilteraddSubscriptionFilter(String id, SubscriptionFilterOptions props) Create a new Subscription Filter on this Log Group.addToResourcePolicy(PolicyStatement statement) Add a statement to the resource's resource policy.final TransformeraddTransformer(String id, TransformerOptions props) Create a new Transformer on this Log Group.final voidapplyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.final MetricextractMetric(String jsonField, String metricNamespace, String metricName) Extract a metric from structured log events in the LogGroup.final ResourceEnvironmentgetEnv()The environment this resource belongs to.final StringThe ARN of this log group, with ':*' appended.final StringThe name of this log group.final software.constructs.NodegetNode()The tree node.final StackgetStack()The stack in which this resource is defined.final Grantgrant(IGrantable grantee, String... actions) Give the indicated permissions on this log group and all streams.final GrantgrantRead(IGrantable grantee) Give permissions to read from this log group and streams.final GrantgrantWrite(IGrantable grantee) Give permissions to write to create and write to streams in this log group.final StringPublic method to get the physical name of this log group.final MetricReturn the given named metric for this Log Group.final Metricmetric(String metricName, MetricOptions props) Return the given named metric for this Log Group.final MetricThe volume of log events in uncompressed bytes uploaded to CloudWatch Logs.final MetricmetricIncomingBytes(MetricOptions props) The volume of log events in uncompressed bytes uploaded to CloudWatch Logs.final MetricThe number of log events uploaded to CloudWatch Logs.final MetricThe number of log events uploaded to CloudWatch Logs.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
getNodein interfacesoftware.constructs.IConstruct- Specified by:
getNodein interfacesoftware.constructs.IConstruct.Jsii$Default- Specified by:
getNodein interfaceILogGroup.Jsii$Default- Specified by:
getNodein interfaceIResource.Jsii$Default- Specified by:
getNodein interfaceIResourceWithPolicy.Jsii$Default
-
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:
getEnvin interfaceILogGroup.Jsii$Default- Specified by:
getEnvin interfaceIResource- Specified by:
getEnvin interfaceIResource.Jsii$Default- Specified by:
getEnvin interfaceIResourceWithPolicy.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStackin interfaceILogGroup.Jsii$Default- Specified by:
getStackin interfaceIResource- Specified by:
getStackin interfaceIResource.Jsii$Default- Specified by:
getStackin interfaceIResourceWithPolicy.Jsii$Default
-
getLogGroupArn
The ARN of this log group, with ':*' appended.- Specified by:
getLogGroupArnin interfaceILogGroup- Specified by:
getLogGroupArnin interfaceILogGroup.Jsii$Default
-
getLogGroupName
The name of this log group.- Specified by:
getLogGroupNamein interfaceILogGroup- Specified by:
getLogGroupNamein interfaceILogGroup.Jsii$Default
-
applyRemovalPolicy
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:
applyRemovalPolicyin interfaceILogGroup.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResource- Specified by:
applyRemovalPolicyin interfaceIResource.Jsii$Default- Specified by:
applyRemovalPolicyin interfaceIResourceWithPolicy.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:
addToResourcePolicyin interfaceILogGroup.Jsii$Default- Specified by:
addToResourcePolicyin interfaceIResourceWithPolicy- Specified by:
addToResourcePolicyin interfaceIResourceWithPolicy.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:
addMetricFilterin interfaceILogGroup- Specified by:
addMetricFilterin interfaceILogGroup.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:
addStreamin interfaceILogGroup- Specified by:
addStreamin interfaceILogGroup.Jsii$Default- Parameters:
id- Unique identifier for the construct in its parent. This parameter is required.props- Properties for creating the LogStream.
-
addStream
Create a new Log Stream for this Log Group. -
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:
addSubscriptionFilterin interfaceILogGroup- Specified by:
addSubscriptionFilterin interfaceILogGroup.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.
-
addTransformer
@Stability(Stable) @NotNull public final Transformer addTransformer(@NotNull String id, @NotNull TransformerOptions props) Create a new Transformer on this Log Group.- Specified by:
addTransformerin interfaceILogGroup- Specified by:
addTransformerin interfaceILogGroup.Jsii$Default- Parameters:
id- Unique identifier for the construct in its parent. This parameter is required.props- Properties for creating the Transformer. 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:
extractMetricin interfaceILogGroup- Specified by:
extractMetricin interfaceILogGroup.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 String... actions) Give the indicated permissions on this log group and all streams.- Specified by:
grantin interfaceILogGroup- Specified by:
grantin interfaceILogGroup.Jsii$Default- Parameters:
grantee- This parameter is required.actions- This parameter is required.
-
grantRead
Give permissions to read from this log group and streams.- Specified by:
grantReadin interfaceILogGroup- Specified by:
grantReadin interfaceILogGroup.Jsii$Default- Parameters:
grantee- This parameter is required.
-
grantWrite
Give permissions to write to create and write to streams in this log group.- Specified by:
grantWritein interfaceILogGroup- Specified by:
grantWritein interfaceILogGroup.Jsii$Default- Parameters:
grantee- This parameter is required.
-
logGroupPhysicalName
Public method to get the physical name of this log group.- Specified by:
logGroupPhysicalNamein interfaceILogGroup- Specified by:
logGroupPhysicalNamein interfaceILogGroup.Jsii$Default
-
metric
@Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this Log Group.- Specified by:
metricin interfaceILogGroup- Specified by:
metricin interfaceILogGroup.Jsii$Default- Parameters:
metricName- The name of the metric. This parameter is required.props- Properties for the metric.
-
metric
Return the given named metric for this Log Group. -
metricIncomingBytes
The volume of log events in uncompressed bytes uploaded to CloudWatch Logs.When used with the LogGroupName dimension, this is the volume of log events in uncompressed bytes uploaded to the log group.
- Specified by:
metricIncomingBytesin interfaceILogGroup- Specified by:
metricIncomingBytesin interfaceILogGroup.Jsii$Default- Parameters:
props- Properties for the Cloudwatch metric.
-
metricIncomingBytes
The volume of log events in uncompressed bytes uploaded to CloudWatch Logs.When used with the LogGroupName dimension, this is the volume of log events in uncompressed bytes uploaded to the log group.
- Specified by:
metricIncomingBytesin interfaceILogGroup
-
metricIncomingLogEvents
@Stability(Stable) @NotNull public final Metric metricIncomingLogEvents(@Nullable MetricOptions props) The number of log events uploaded to CloudWatch Logs.When used with the LogGroupName dimension, this is the number of log events uploaded to the log group.
- Specified by:
metricIncomingLogEventsin interfaceILogGroup- Specified by:
metricIncomingLogEventsin interfaceILogGroup.Jsii$Default- Parameters:
props- Properties for the Cloudwatch metric.
-
metricIncomingLogEvents
The number of log events uploaded to CloudWatch Logs.When used with the LogGroupName dimension, this is the number of log events uploaded to the log group.
- Specified by:
metricIncomingLogEventsin interfaceILogGroup
-