KeywordLib

• Implements: IKeywordLib

This class encapsulates and extends the ROS resource type ALIYUN::Aligreen::KeywordLib, which is used to create a custom text library.

Initializers

import ros_cdk_aligreen
ros_cdk_aligreen.KeywordLib(
  scope: Construct,
  id: str,
  keyword_lib_name: typing.Union[str, IResolvable],
  resource_type: typing.Union[str, IResolvable],
  biz_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  category: typing.Union[str, IResolvable] = None,
  enable: typing.Union[bool, IResolvable] = None,
  language: typing.Union[str, IResolvable] = None,
  lib_type: typing.Union[str, IResolvable] = None,
  match_mode: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

keyword_lib_name^Required

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

Property keywordLibName: The name of the keyword library defined by the customer.

It can contain no more than 20 characters in Chinese, English, and underscore (_).

resource_type^Required

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

Property resourceType: The moderation scenario to which the text library applies.

Valid values:TEXT: text anti-spam、IMAGE: ad violation detection、VOICE: audio anti-spam.

biz_types^Optional

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

Property bizTypes: The business scenario.

Example:["bizTypeA","bizTypeB"].

category^Optional

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

Property category: The category of the text library.

Valid values: BLACK: a blacklist. WHITE: a whitelist. REVIEW: a review list.

enable^Optional

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

Property enable: Specifies whether to enable text library.true: Enable the text library. This is the default value.false: Disable the text library.

language^Optional

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

Property language: Language used by the text Library.

Example: zh:Chinese、en:English

lib_type^Optional

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

Property libType: The category of the text library in each moderation scenario.

Valid values: textKeyword: a text library against which terms in text are matched. similarText: a text library against which text patterns are matched. voiceText: a text library against which terms converted from audio are matched.

match_mode^Optional

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

Property matchMode: The matching method.

Valid values:fuzzy: fuzzy match precise: exact match.

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_aligreen
ros_cdk_aligreen.KeywordLib.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_biz_types^Required

attr_biz_types: typing.Union[str, IResolvable]

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

Attribute BizTypes: The business scenario.

attr_category^Required

attr_category: typing.Union[str, IResolvable]

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

Attribute Category: The category of the text library.

attr_enable^Required

attr_enable: typing.Union[str, IResolvable]

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

Attribute Enable: Specifies whether to enable text library.

attr_keyword_lib_id^Required

attr_keyword_lib_id: typing.Union[str, IResolvable]

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

Attribute KeywordLibId: The ID of the primary key of the keyword library.

attr_keyword_lib_name^Required

attr_keyword_lib_name: typing.Union[str, IResolvable]

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

Attribute KeywordLibName: The name of the keyword library defined by the customer.

attr_language^Required

attr_language: typing.Union[str, IResolvable]

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

Attribute Language: Language used by the text Library.

attr_lib_type^Required

attr_lib_type: typing.Union[str, IResolvable]

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

Attribute LibType: The category of the text library in each moderation scenario.

attr_match_mode^Required

attr_match_mode: typing.Union[str, IResolvable]

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

Attribute MatchMode: The matching method.

attr_resource_type^Required

attr_resource_type: typing.Union[str, IResolvable]

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

Attribute ResourceType: The moderation scenario to which the text library applies.

props^Required

props: KeywordLibProps

• Type: KeywordLibProps