aws-cdk-lib.aws_logs.LogStream

class LogStream (construct)

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

Implements IConstruct, IDependable, IResource, ILogStream

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 LogStreamProps

Construct Props

NameTypeDescription
logGroupILogGroupThe log group to create a log stream for.
logStreamName?stringThe name of the log stream to create.
removalPolicy?RemovalPolicyDetermine what happens when the log stream resource is removed from the app.

logGroup

Type: ILogGroup

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: RemovalPolicy (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

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
logStreamNamestringThe name of this log stream.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

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

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromLogStreamName(scope, id, logStreamName)Import an existing LogGroup.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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

  • ILogStream

Import an existing LogGroup.