Package software.amazon.awscdk.services.logs

Interface LogGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LogGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:54:07.344Z")
@Stability(Stable)
public interface LogGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for a LogGroup.

Example:

 Repository repository = Repository.Builder.create(this, "TestRepository")
         .repositoryName("test-agent-runtime")
         .build();
 AgentRuntimeArtifact agentRuntimeArtifact = AgentRuntimeArtifact.fromEcrRepository(repository, "v1.0.0");
 // Use a /aws/vendedlogs/ log group for same-account delivery without explicit resource policy
 LogGroup logGroup = LogGroup.Builder.create(this, "RuntimeLogGroup")
         .logGroupName("/aws/vendedlogs/bedrock-agentcore/my-runtime")
         .build();
 Runtime.Builder.create(this, "test-runtime")
         .runtimeName("test_runtime")
         .agentRuntimeArtifact(agentRuntimeArtifact)
         .tracingEnabled(true)
         .loggingConfigs(List.of(LoggingConfig.builder()
                 .logType(LogType.APPLICATION_LOGS)
                 .destination(LoggingDestination.cloudWatchLogs(logGroup))
                 .build()))
         .manageDeliveryResourcePolicy(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LogGroupProps.Builder	A builder for LogGroupProps
static final class	LogGroupProps.Jsii$Proxy	An implementation for LogGroupProps

Method Summary

Modifier and Type	Method	Description
static LogGroupProps.Builder	builder()
default DataProtectionPolicy	getDataProtectionPolicy()	Data Protection Policy for this log group.
default Boolean	getDeletionProtectionEnabled()	Indicates whether deletion protection is enabled for this log group.
default IKeyRef	getEncryptionKey()	The KMS customer managed key to encrypt the log group with.
default List<FieldIndexPolicy>	getFieldIndexPolicies()	Field Index Policies for this log group.
default LogGroupClass	getLogGroupClass()	The class of the log group.
default String	getLogGroupName()	Name of the log group.
default RemovalPolicy	getRemovalPolicy()	Determine the removal policy of this log group.
default RetentionDays	getRetention()	How long, in days, the log contents will be retained.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataProtectionPolicy

@Stability(Stable)
@Nullable
default DataProtectionPolicy getDataProtectionPolicy()

Data Protection Policy for this log group.

Default: - no data protection policy

getDeletionProtectionEnabled

@Stability(Stable)
@Nullable
default Boolean getDeletionProtectionEnabled()

Indicates whether deletion protection is enabled for this log group.

When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.

Default: false

getEncryptionKey

@Stability(Stable)
@Nullable
default IKeyRef getEncryptionKey()

The KMS customer managed key to encrypt the log group with.

Default: Server-side encryption managed by the CloudWatch Logs service

getFieldIndexPolicies

@Stability(Stable)
@Nullable
default List<FieldIndexPolicy> getFieldIndexPolicies()

Field Index Policies for this log group.

Default: - no field index policies for this log group.

getLogGroupClass

@Stability(Stable)
@Nullable
default LogGroupClass getLogGroupClass()

The class of the log group. Possible values are: STANDARD, INFREQUENT_ACCESS and DELIVERY.

INFREQUENT_ACCESS class provides customers a cost-effective way to consolidate logs which supports querying using Logs Insights. The logGroupClass property cannot be changed once the log group is created.

DELIVERY class is used to deliver logs to a destination such as Amazon S3 or Amazon Data Firehose (for example, Lambda vended logs). A Delivery log group forwards events to a destination instead of storing them, so it does not support retention, dataProtectionPolicy, or fieldIndexPolicies; setting any of these together with LogGroupClass.DELIVERY results in a synthesis-time error.

Default: LogGroupClass.STANDARD

getLogGroupName

@Stability(Stable)
@Nullable
default String getLogGroupName()

Name of the log group.

Default: Automatically generated

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

Determine the removal policy of this log group.

Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs.

Default: RemovalPolicy.Retain

getRetention

@Stability(Stable)
@Nullable
default RetentionDays getRetention()

How long, in days, the log contents will be retained.

To retain all logs, set this value to RetentionDays.INFINITE.

Default: RetentionDays.TWO_YEARS

builder

@Stability(Stable)
static LogGroupProps.Builder builder()

Returns:

a LogGroupProps.Builder of LogGroupProps