LogStream

class aws_cdk.aws_logs.LogStream(scope, id, *, log_group, log_stream_name=None, removal_policy=None)

Bases: aws_cdk.core.Resource

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 aws_cdk.aws_logs as logs
import aws_cdk.core as cdk

# log_group is of type LogGroup

log_stream = logs.LogStream(self, "MyLogStream",
    log_group=log_group,

    # the properties below are optional
    log_stream_name="logStreamName",
    removal_policy=cdk.RemovalPolicy.DESTROY
)
Parameters

  • scope (Construct) –

  • id (str) –

  • log_group (ILogGroup) – The log group to create a log stream for.

  • log_stream_name (Optional[str]) – The name of the log stream to create. The name must be unique within the log group. Default: Automatically generated

  • removal_policy (Optional[RemovalPolicy]) – 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. Default: RemovalPolicy.Retain

Methods

apply_removal_policy(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).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

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.

Return type

ResourceEnvironment

log_stream_name

The name of this log stream.

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_log_stream_name(scope, id, log_stream_name)

Import an existing LogGroup.

Parameters

  • scope (Construct) –

  • id (str) –

  • log_stream_name (str) –

Return type

ILogStream

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool