class LogStream (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Logs.LogStream |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslogs#LogStream |
![]() | software.amazon.awscdk.services.logs.LogStream |
![]() | aws_cdk.aws_logs.LogStream |
![]() | aws-cdk-lib » aws_logs » LogStream |
Implements
IConstruct
, IDependable
, IResource
, ILog
Define a Log Stream in a Log Group.
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 logStream = new logs.LogStream(this, 'MyLogStream', {
logGroup: logGroup,
// the properties below are optional
logStreamName: 'logStreamName',
removalPolicy: cdk.RemovalPolicy.DESTROY,
});
Initializer
new LogStream(scope: Construct, id: string, props: LogStreamProps)
Parameters
- scope
Construct
- id
string
- props
Log
Stream Props
Construct Props
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.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
log | string | The name of this log stream. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
logStreamName
Type:
string
The name of this log stream.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Import an existing LogGroup. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromLogStreamName(scope, id, logStreamName)
public static fromLogStreamName(scope: Construct, id: string, logStreamName: string): ILogStream
Parameters
- scope
Construct
- id
string
- logStreamName
string
Returns
Import an existing LogGroup.