Index

This class encapsulates and extends the ROS resource type ALIYUN::SLS::Index, which is used to create an index for a specified Logstore.

Initializers

import com.aliyun.ros.cdk.sls.Index;
Index.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fullTextIndex(IResolvable)
    .fullTextIndex(FullTextIndexProperty)
    .logstoreName(java.lang.String)
    .logstoreName(IResolvable)
    .projectName(java.lang.String)
    .projectName(IResolvable)
//  .keyIndices(IResolvable)
//  .keyIndices(java.util.List<IResolvable)
//  .keyIndices(KeyIndicesProperty>)
//  .logReduce(java.lang.Boolean)
//  .logReduce(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.
fullTextIndex	com.aliyun.ros.cdk.core.IResolvable OR FullTextIndexProperty	Property fullTextIndex: Full-text indexing configuration.
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.
keyIndices	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListKeyIndicesProperty>	Property keyIndices: Key index configurations.
logReduce	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property logReduce: Whether to enable log reduce.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

fullTextIndex^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR FullTextIndexProperty

Property fullTextIndex: Full-text indexing configuration.

Full-text indexing and key indexing must have at least one enabled.

---

logstoreName^Required

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

---

projectName^Required

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

---

keyIndices^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListKeyIndicesProperty>

Property keyIndices: Key index configurations.

Full-text indexing and key indexing must have at least one enabled.

---

logReduce^Optional

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

Property logReduce: Whether to enable log reduce.

Default to false.

---

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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

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

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---