Logstore

• Implements: ILogstore

This class encapsulates and extends the ROS resource type ALIYUN::SLS::Logstore.

Initializers

import ros_cdk_sls
ros_cdk_sls.Logstore(
  scope: Construct,
  id: str,
  logstore_name: typing.Union[str, IResolvable],
  project_name: typing.Union[str, IResolvable],
  append_meta: typing.Union[bool, IResolvable] = None,
  auto_split: typing.Union[bool, IResolvable] = None,
  enable_tracking: typing.Union[bool, IResolvable] = None,
  encrypt_conf: typing.Union[IResolvable, EncryptConfProperty] = None,
  max_split_shard: typing.Union[typing.Union[int, float], IResolvable] = None,
  mode: typing.Union[str, IResolvable] = None,
  preserve_storage: typing.Union[bool, IResolvable] = None,
  shard_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ttl: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

logstore_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property logstoreName: Logstore name: 1.

Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.

project_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property projectName: Project name: 1.

Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.

append_meta^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property appendMeta: Whether to add client external network IP and log arrival time after receiving the log.

Default to false.

auto_split^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoSplit: Whether to automatically split the shard.

Default to false.

enable_tracking^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableTracking: Whether to enable WebTracking, which supports fast capture of various browsers and iOS\/Android\/APP access information.

Default to false.

encrypt_conf^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, EncryptConfProperty]

Property encryptConf: Data encryption config.

max_split_shard^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property maxSplitShard: The maximum number of shards when splitting automatically.

Must be specified if AutoSplit is set to true. Allowed Values: 1-64.

mode^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mode: The type of the Logstore.

Simple Log Service provides two types of Logstores: Standard Logstores and Query Logstores. Valid values: standard: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system. query: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the amount of data is large, the log retention period is long, or log analysis is not required. If logs are stored for weeks or months, the log retention period is considered long.

preserve_storage^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property preserveStorage: Whether to keep the log permanently.

If set to true, TTL will be ignored. Default to false.

shard_count^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property shardCount: The number of Shards.

Allowed Values: 1-100, default to 2.

ttl^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property ttl: The lifecycle of log in the logstore in days.

Allowed Values: 1-3650, default to 30.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_sls
ros_cdk_sls.Logstore.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_logstore_name^Required

attr_logstore_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute LogstoreName: Logstore name.

attr_project_name^Required

attr_project_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ProjectName: Project name.

props^Required

props: LogstoreProps

• Type: LogstoreProps