interface LogGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.Logs.LogGroupProps
Java	software.amazon.awscdk.services.logs.LogGroupProps
Python	aws_cdk.aws_logs.LogGroupProps
TypeScript (source)	@aws-cdk/aws-logs » LogGroupProps

Properties for a LogGroup.

Example

declare const vpc: ec2.Vpc;
const kmsKey = new kms.Key(this, 'KmsKey');

// Pass the KMS key in the `encryptionKey` field to associate the key to the log group
const logGroup = new logs.LogGroup(this, 'LogGroup', {
  encryptionKey: kmsKey,
});

// Pass the KMS key in the `encryptionKey` field to associate the key to the S3 bucket
const execBucket = new s3.Bucket(this, 'EcsExecBucket', {
  encryptionKey: kmsKey,
});

const cluster = new ecs.Cluster(this, 'Cluster', {
  vpc,
  executeCommandConfiguration: {
    kmsKey,
    logConfiguration: {
      cloudWatchLogGroup: logGroup,
      cloudWatchEncryptionEnabled: true,
      s3Bucket: execBucket,
      s3EncryptionEnabled: true,
      s3KeyPrefix: 'exec-command-output',
    },
    logging: ecs.ExecuteCommandLogging.OVERRIDE,
  },
});

Properties

Name	Type	Description
encryptionKey?	IKey	The KMS Key to encrypt the log group with.
logGroupName?	string	Name of the log group.
removalPolicy?	RemovalPolicy	Determine the removal policy of this log group.
retention?	RetentionDays	How long, in days, the log contents will be retained.

---

encryptionKey?

Type: IKey (optional, default: log group is encrypted with the default master key)

The KMS Key to encrypt the log group with.

---

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.