Skip to content

Logstore

This class encapsulates and extends the ROS resource type ALIYUN::SLS::Logstore, which is used to create a Logstore in a Log Service project.

Initializers 

import com.aliyun.ros.cdk.sls.Logstore;
Logstore.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .logstoreName(java.lang.String)
    .logstoreName(IResolvable)
    .projectName(java.lang.String)
    .projectName(IResolvable)
//  .appendMeta(java.lang.Boolean)
//  .appendMeta(IResolvable)
//  .autoSplit(java.lang.Boolean)
//  .autoSplit(IResolvable)
//  .enableTracking(java.lang.Boolean)
//  .enableTracking(IResolvable)
//  .encryptConf(IResolvable)
//  .encryptConf(EncryptConfProperty)
//  .maxSplitShard(java.lang.Number)
//  .maxSplitShard(IResolvable)
//  .preserveStorage(java.lang.Boolean)
//  .preserveStorage(IResolvable)
//  .shardCount(java.lang.Number)
//  .shardCount(IResolvable)
//  .ttl(java.lang.Number)
//  .ttl(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
logstoreName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property logstoreName: Logstore name: 1.
projectName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property projectName: Project name: 1.
appendMeta java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property appendMeta: Whether to add client external network IP and log arrival time after receiving the log.
autoSplit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoSplit: Whether to automatically split the shard.
enableTracking java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableTracking: Whether to enable WebTracking, which supports fast capture of various browsers and iOS\/Android\/APP access information.
encryptConf com.aliyun.ros.cdk.core.IResolvable OR EncryptConfProperty Property encryptConf: Data encryption config.
maxSplitShard java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxSplitShard: The maximum number of shards when splitting automatically.
preserveStorage java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property preserveStorage: Whether to keep the log permanently.
shardCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property shardCount: The number of Shards.
ttl java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property ttl: The lifecycle of log in the logstore in days.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

logstoreNameRequired

  • Type: java.lang.String OR com.aliyun.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.

projectNameRequired

  • Type: java.lang.String OR com.aliyun.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.

appendMetaOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Default to false.

autoSplitOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoSplit: Whether to automatically split the shard.

Default to false.

enableTrackingOptional

  • Type: java.lang.Boolean OR com.aliyun.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.

encryptConfOptional

Property encryptConf: Data encryption config.

maxSplitShardOptional

  • Type: java.lang.Number OR com.aliyun.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.

preserveStorageOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property preserveStorage: Whether to keep the log permanently.

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

shardCountOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property shardCount: The number of Shards.

Allowed Values: 1-100, default to 2.

ttlOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Allowed Values: 1-3600, default to 30.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.sls.Logstore;
Logstore.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrLogstoreName com.aliyun.ros.cdk.core.IResolvable Attribute LogstoreName: Logstore name.
attrProjectName com.aliyun.ros.cdk.core.IResolvable Attribute ProjectName: Project name.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrLogstoreNameRequired 

public IResolvable getAttrLogstoreName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LogstoreName: Logstore name.

attrProjectNameRequired 

public IResolvable getAttrProjectName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProjectName: Project name.