Package software.amazon.awscdk.services.logs

Class CfnLogGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.logs.CfnLogGroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ILogGroupRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:39.843Z") @Stability(Stable) public class CfnLogGroup extends CfnResource implements IInspectable, ILogGroupRef, ITaggable
The AWS::Logs::LogGroup resource specifies a log group.

A log group defines common properties for log streams, such as their retention and access control rules. Each log stream must belong to one log group.

You can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:

  • Log group names must be unique within a Region for an AWS account.
  • Log group names can be between 1 and 512 characters long.
  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

Example: 

 // Works across different resource types
 CfnBucket bucket = new CfnBucket(scope, "Bucket");
 Mixins.of(bucket).apply(new EncryptionAtRest());
 CfnLogGroup logGroup = new CfnLogGroup(scope, "LogGroup");
 Mixins.of(logGroup).apply(new EncryptionAtRest());

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLogGroup

      protected CfnLogGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLogGroup

      protected CfnLogGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLogGroup

      @Stability(Stable) public CfnLogGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnLogGroupProps props)
      Create a new AWS::Logs::LogGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnLogGroup

      @Stability(Stable) public CfnLogGroup(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Logs::LogGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForLogGroup

      @Stability(Stable) @NotNull public static String arnForLogGroup(@NotNull ILogGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • fromLogGroupArn

      @Stability(Stable) @NotNull public static ILogGroupRef fromLogGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ILogGroupRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromLogGroupName

      @Stability(Stable) @NotNull public static ILogGroupRef fromLogGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String logGroupName)
      Creates a new ILogGroupRef from a logGroupName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      logGroupName - This parameter is required.

    • isCfnLogGroup

      @Stability(Stable) @NotNull public static Boolean isCfnLogGroup(@NotNull Object x)
      Checks whether the given object is a CfnLogGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the log group, such as arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLogGroupRef

      @Stability(Stable) @NotNull public LogGroupReference getLogGroupRef()
      A reference to a LogGroup resource.
      Specified by:
      getLogGroupRef in interface ILogGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDataProtectionPolicy

      @Stability(Stable) @Nullable public Object getDataProtectionPolicy()
      Creates a data protection policy and assigns it to the log group.

    • setDataProtectionPolicy

      @Stability(Stable) public void setDataProtectionPolicy(@Nullable Object value)
      Creates a data protection policy and assigns it to the log group.

    • getFieldIndexPolicies

      @Stability(Stable) @Nullable public Object getFieldIndexPolicies()
      Creates or updates a field index policy for the specified log group.

      Returns union: either Listinvalid input: '<'Object> or IResolvable

    • setFieldIndexPolicies

      @Stability(Stable) public void setFieldIndexPolicies(@Nullable List<Object> value)
      Creates or updates a field index policy for the specified log group.

    • setFieldIndexPolicies

      @Stability(Stable) public void setFieldIndexPolicies(@Nullable IResolvable value)
      Creates or updates a field index policy for the specified log group.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The Amazon Resource Name (ARN) of the AWS key to use when encrypting log data.

    • getLogGroupClass

      @Stability(Stable) @Nullable public String getLogGroupClass()
      Specifies the log group class for this log group.

      There are two classes:.

    • setLogGroupClass

      @Stability(Stable) public void setLogGroupClass(@Nullable String value)
      Specifies the log group class for this log group.

      There are two classes:.

    • getLogGroupName

      @Stability(Stable) @Nullable public String getLogGroupName()
      The name of the log group.

    • setLogGroupName

      @Stability(Stable) public void setLogGroupName(@Nullable String value)
      The name of the log group.

    • getResourcePolicyDocument

      @Stability(Stable) @Nullable public Object getResourcePolicyDocument()
      Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.

    • setResourcePolicyDocument

      @Stability(Stable) public void setResourcePolicyDocument(@Nullable Object value)
      Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.

    • getRetentionInDays

      @Stability(Stable) @Nullable public Number getRetentionInDays()
      The number of days to retain the log events in the specified log group.

    • setRetentionInDays

      @Stability(Stable) public void setRetentionInDays(@Nullable Number value)
      The number of days to retain the log events in the specified log group.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to the log group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to the log group.