2.269.0

interface LogGroupProps

LanguageType name
.NETAmazon.CDK.AWS.Logs.LogGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslogs#LogGroupProps
Javasoftware.amazon.awscdk.services.logs.LogGroupProps
Pythonaws_cdk.aws_logs.LogGroupProps
TypeScript (source)aws-cdk-lib » aws_logs » LogGroupProps

Properties for a LogGroup.

Example

const repository = new ecr.Repository(this, 'TestRepository', {
  repositoryName: 'test-agent-runtime',
});

const agentRuntimeArtifact = agentcore.AgentRuntimeArtifact.fromEcrRepository(repository, 'v1.0.0');

// Use a /aws/vendedlogs/ log group for same-account delivery without explicit resource policy
const logGroup = new logs.LogGroup(this, 'RuntimeLogGroup', {
  logGroupName: '/aws/vendedlogs/bedrock-agentcore/my-runtime',
});

new agentcore.Runtime(this, 'test-runtime', {
  runtimeName: 'test_runtime',
  agentRuntimeArtifact: agentRuntimeArtifact,
  tracingEnabled: true,
  loggingConfigs: [
    {
      logType: agentcore.LogType.APPLICATION_LOGS,
      destination: agentcore.LoggingDestination.cloudWatchLogs(logGroup),
    },
  ],
  manageDeliveryResourcePolicy: false,
});

Properties

NameTypeDescription
dataProtectionPolicy?DataProtectionPolicyData Protection Policy for this log group.
deletionProtectionEnabled?booleanIndicates whether deletion protection is enabled for this log group.
encryptionKey?IKeyRefThe KMS customer managed key to encrypt the log group with.
fieldIndexPolicies?FieldIndexPolicy[]Field Index Policies for this log group.
logGroupClass?LogGroupClassThe class of the log group. Possible values are: STANDARD, INFREQUENT_ACCESS and DELIVERY.
logGroupName?stringName of the log group.
removalPolicy?RemovalPolicyDetermine the removal policy of this log group.
retention?RetentionDaysHow long, in days, the log contents will be retained.

dataProtectionPolicy?

Type: DataProtectionPolicy (optional, default: no data protection policy)

Data Protection Policy for this log group.

deletionProtectionEnabled?

Type: boolean (optional, default: false)

Indicates whether deletion protection is enabled for this log group.

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

encryptionKey?

Type: IKeyRef (optional, default: Server-side encryption managed by the CloudWatch Logs service)

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

fieldIndexPolicies?

Type: FieldIndexPolicy[] (optional, default: no field index policies for this log group.)

Field Index Policies for this log group.

logGroupClass?

Type: LogGroupClass (optional, default: LogGroupClass.STANDARD)

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.

logGroupName?

Type: string (optional, default: Automatically generated)

Name of the log group.

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.Retain)

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.

retention?

Type: RetentionDays (optional, default: RetentionDays.TWO_YEARS)

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

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

← PreviousNext →