interface LogStreamProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Logs.LogStreamProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awslogs#LogStreamProps |
 Java | software.amazon.awscdk.services.logs.LogStreamProps |
 Python | aws_cdk.aws_logs.LogStreamProps |
 TypeScript (source) | aws-cdk-lib » aws_logs » LogStreamProps |
Properties for a LogStream.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';
declare const logGroup: logs.LogGroup;
const logStreamProps: logs.LogStreamProps = {
logGroup: logGroup,
// the properties below are optional
logStreamName: 'logStreamName',
removalPolicy: cdk.RemovalPolicy.DESTROY,
};
Properties
| Name | Type | Description |
|---|---|---|
| log | ILog | The log group to create a log stream for. |
| log | string | The name of the log stream to create. |
| removal | Removal | Determine what happens when the log stream resource is removed from the app. |
logGroup
Type:
ILog
The log group to create a log stream for.
logStreamName?
Type:
string
(optional, default: Automatically generated)
The name of the log stream to create.
The name must be unique within the log group.
removalPolicy?
Type:
Removal
(optional, default: RemovalPolicy.Retain)
Determine what happens when the log stream resource is removed from the app.
Normally you want to retain the log stream so you can diagnose issues from logs even after a deployment that no longer includes the log stream.
The date-based retention policy of your log group will age out the logs after a certain time.