class LogStream (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Logs.LogStream
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslogs#LogStream
Java	software.amazon.awscdk.services.logs.LogStream
Python	aws_cdk.aws_logs.LogStream
TypeScript (source)	aws-cdk-lib » aws_logs » LogStream

Implements IConstruct, IDependable, IResource, IEnvironmentAware, ILogStream, ILogStreamRef

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';
import { aws_logs as interfaces_logs } from 'aws-cdk-lib/interfaces';

declare const logGroupRef: interfaces_logs.ILogGroupRef;
const logStream = new logs.LogStream(this, 'MyLogStream', {
  logGroup: logGroupRef,

  // 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

Name	Type	Description
logGroup	ILogGroupRef	The log group to create a log stream for.
logStreamName?	string	The name of the log stream to create.
removalPolicy?	RemovalPolicy	Determine what happens when the log stream resource is removed from the app.

---

logGroup

Type: ILogGroupRef

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

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
logStreamName	string	The name of this log stream.
logStreamRef	LogStreamReference	A reference to a LogStream resource.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

logStreamName

Type: string

The name of this log stream.

---

logStreamRef

Type: LogStreamReference

A reference to a LogStream resource.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromLogStreamAttributes(scope, id, attrs)	Import an existing LogStream using its attributes.
static fromLogStreamName(scope, id, logStreamName)	Import an existing LogStream.

---

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 fromLogStreamAttributes(scope, id, attrs)

public static fromLogStreamAttributes(scope: Construct, id: string, attrs: LogStreamAttributes): ILogStream

Parameters

• scope Construct
• id string
• attrs LogStreamAttributes

Returns

• ILogStream

Import an existing LogStream using its attributes.

---

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 LogStream.