Package software.amazon.awscdk.services.logs

Interface ILogGroup.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, ILogGroup, ILogGroupRef, ILogGroupRef.Jsii$Default, IResource, IResource.Jsii$Default, IResourceWithPolicy, IResourceWithPolicy.Jsii$Default, IResourceWithPolicyV2, IResourceWithPolicyV2.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ILogGroup.Jsii$Proxy
Enclosing interface:
ILogGroup
@Internal public static interface ILogGroup.Jsii$Default extends ILogGroup, ILogGroupRef.Jsii$Default, IResourceWithPolicy.Jsii$Default
Internal default implementation for ILogGroup.

  • Method Details

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      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.

      Specified by:
      getEnv in interface IEnvironmentAware
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      Specified by:
      getEnv in interface ILogGroup
      Specified by:
      getEnv in interface ILogGroupRef.Jsii$Default
      Specified by:
      getEnv in interface IResource.Jsii$Default
      Specified by:
      getEnv in interface IResourceWithPolicy
      Specified by:
      getEnv in interface IResourceWithPolicy.Jsii$Default
      Specified by:
      getEnv in interface IResourceWithPolicyV2.Jsii$Default

    • getNode

      @Stability(Stable) @NotNull default 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
      Specified by:
      getNode in interface ILogGroupRef.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default
      Specified by:
      getNode in interface IResourceWithPolicy.Jsii$Default

    • getStack

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

    • getLogGroupRef

      @Stability(Experimental) @NotNull default LogGroupReference getLogGroupRef()
      (experimental) A reference to a LogGroup resource.
      Specified by:
      getLogGroupRef in interface ILogGroupRef
      Specified by:
      getLogGroupRef in interface ILogGroupRef.Jsii$Default

    • getLogGroupArn

      @Stability(Stable) @NotNull default String getLogGroupArn()
      The ARN of this log group, with ':*' appended.
      Specified by:
      getLogGroupArn in interface ILogGroup

    • getLogGroupName

      @Stability(Stable) @NotNull default String getLogGroupName()
      The name of this log group.
      Specified by:
      getLogGroupName in interface ILogGroup

    • addToResourcePolicy

      @Stability(Stable) @NotNull default AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement)
      Add a statement to the resource's resource policy.

      Specified by:
      addToResourcePolicy in interface IResourceWithPolicy.Jsii$Default
      Specified by:
      addToResourcePolicy in interface IResourceWithPolicyV2
      Specified by:
      addToResourcePolicy in interface IResourceWithPolicyV2.Jsii$Default
      Parameters:
      statement - This parameter is required.

    • applyRemovalPolicy

      @Stability(Stable) default 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 IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IResourceWithPolicy.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addMetricFilter

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

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

    • addSubscriptionFilter

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

    • addTransformer

      @Stability(Stable) @NotNull default Transformer addTransformer(@NotNull String id, @NotNull TransformerOptions props)
      Create a new Transformer on this Log Group.

      Specified by:
      addTransformer in interface ILogGroup
      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 default 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
      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 default Grant grant(@NotNull IGrantable grantee, @NotNull 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.

    • grantRead

      @Stability(Stable) @NotNull default Grant grantRead(@NotNull IGrantable grantee)
      Give permissions to read from this log group and streams.

      Specified by:
      grantRead in interface ILogGroup
      Parameters:
      grantee - This parameter is required.

    • grantWrite

      @Stability(Stable) @NotNull default 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
      Parameters:
      grantee - This parameter is required.

    • logGroupPhysicalName

      @Stability(Stable) @NotNull default String logGroupPhysicalName()
      Public method to get the physical name of this log group.
      Specified by:
      logGroupPhysicalName in interface ILogGroup

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this Log Group.

      Specified by:
      metric in interface ILogGroup
      Parameters:
      metricName - The name of the metric. This parameter is required.
      props - Properties for the metric.

    • metricIncomingBytes

      @Stability(Stable) @NotNull default Metric metricIncomingBytes(@Nullable MetricOptions props)
      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:
      metricIncomingBytes in interface ILogGroup
      Parameters:
      props - Properties for the Cloudwatch metric.

    • metricIncomingLogEvents

      @Stability(Stable) @NotNull default 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:
      metricIncomingLogEvents in interface ILogGroup
      Parameters:
      props - Properties for the Cloudwatch metric.