Skip to content

KeywordLib

This class encapsulates and extends the ROS resource type ALIYUN::Aligreen::KeywordLib.

Initializers

import { KeywordLib } from '@alicloud/ros-cdk-aligreen'
new KeywordLib(scope: Construct, id: string, props: KeywordLibProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props KeywordLibProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { KeywordLib } from '@alicloud/ros-cdk-aligreen'
KeywordLib.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrBizTypes string | @alicloud/ros-cdk-core.IResolvable Attribute BizTypes: The business scenario.
attrCategory string | @alicloud/ros-cdk-core.IResolvable Attribute Category: The category of the text library.
attrEnable string | @alicloud/ros-cdk-core.IResolvable Attribute Enable: Specifies whether to enable text library.
attrKeywordLibId string | @alicloud/ros-cdk-core.IResolvable Attribute KeywordLibId: The ID of the primary key of the keyword library.
attrKeywordLibName string | @alicloud/ros-cdk-core.IResolvable Attribute KeywordLibName: The name of the keyword library defined by the customer.
attrLanguage string | @alicloud/ros-cdk-core.IResolvable Attribute Language: Language used by the text Library.
attrLibType string | @alicloud/ros-cdk-core.IResolvable Attribute LibType: The category of the text library in each moderation scenario.
attrMatchMode string | @alicloud/ros-cdk-core.IResolvable Attribute MatchMode: The matching method.
attrResourceType string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceType: The moderation scenario to which the text library applies.
props KeywordLibProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrBizTypesRequired

public readonly attrBizTypes: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BizTypes: The business scenario.


attrCategoryRequired

public readonly attrCategory: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Category: The category of the text library.


attrEnableRequired

public readonly attrEnable: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Enable: Specifies whether to enable text library.


attrKeywordLibIdRequired

public readonly attrKeywordLibId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrKeywordLibNameRequired

public readonly attrKeywordLibName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrLanguageRequired

public readonly attrLanguage: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Language: Language used by the text Library.


attrLibTypeRequired

public readonly attrLibType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


attrMatchModeRequired

public readonly attrMatchMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MatchMode: The matching method.


attrResourceTypeRequired

public readonly attrResourceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


propsRequired

public readonly props: KeywordLibProps;