RosIndex

This class is a base encapsulation around the ROS resource type ALIYUN::Bailian::Index.

Initializers

import { RosIndex } from '@alicloud/ros-cdk-bailian'
new RosIndex(scope: Construct, id: string, props: RosIndexProps, enableResourcePropertyConstraint: boolean)

scope^Required

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

scope in which this resource is defined.

id^Required

• Type: string

scoped id of the resource.

props^Required

• Type: RosIndexProps

resource properties.

enableResourcePropertyConstraint^Required

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

addCondition

public addCondition(con: RosCondition): void

con^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: string

The path of the value to delete.

addDependsOn

public addDependsOn(target: RosResource): void

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

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

addDesc

public addDesc(desc: string): void

desc^Required

• Type: string

addMetaData

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

key^Required

• Type: string

value^Required

• Type: any

addOverride

public addOverride(path: string, value: any): void

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: any

The value.

Could be primitive or complex.

addPropertyDeletionOverride

public addPropertyDeletionOverride(propertyPath: string): void

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: string

The path to the property.

addPropertyOverride

public addPropertyOverride(propertyPath: string, value: any): void

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: string

The path of the property.

value^Required

• Type: any

The value.

addRosDependency

public addRosDependency(target: string): void

target^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

options^Optional

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

fetchCondition

public fetchCondition(): RosCondition

fetchDesc

public fetchDesc(): string

fetchRosDependency

public fetchRosDependency(): string[]

getAtt

public getAtt(attributeName: string): Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeName^Required

• Type: string

The name of the attribute.

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

isRosElement

import { RosIndex } from '@alicloud/ros-cdk-bailian'
RosIndex.isRosElement(x: any)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: any

isRosResource

import { RosIndex } from '@alicloud/ros-cdk-bailian'
RosIndex.isRosResource(construct: IConstruct)

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

logicalId^Required

public readonly logicalId: string;

• Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

public readonly stack: Stack;

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

public readonly ref: string;

• Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptions^Required

public readonly rosOptions: IRosResourceOptions;

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

Options for this resource, such as condition, update policy etc.

rosResourceType^Required

public readonly rosResourceType: string;

• Type: string

ROS resource type.

attrId^Required

public readonly attrId: IResolvable;

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

enableResourcePropertyConstraint^Required

public readonly enableResourcePropertyConstraint: boolean;

• Type: boolean

name^Required

public readonly name: string | IResolvable;

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

sourceType^Required

public readonly sourceType: string | IResolvable;

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

structureType^Required

public readonly structureType: string | IResolvable;

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

workspaceId^Required

public readonly workspaceId: string | IResolvable;

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

categoryIds^Optional

public readonly categoryIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

chunkMode^Optional

public readonly chunkMode: string | IResolvable;

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

chunkSize^Optional

public readonly chunkSize: number | IResolvable;

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

connectId^Optional

public readonly connectId: string | IResolvable;

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

database^Optional

public readonly database: string | IResolvable;

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

denseSimilarityTopK^Optional

public readonly denseSimilarityTopK: number | IResolvable;

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

description^Optional

public readonly description: string | IResolvable;

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

documentIds^Optional

public readonly documentIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

embeddingModelName^Optional

public readonly embeddingModelName: string | IResolvable;

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

enableHeaders^Optional

public readonly enableHeaders: boolean | IResolvable;

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

enableRewrite^Optional

public readonly enableRewrite: boolean | IResolvable;

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

knowledgeScene^Optional

public readonly knowledgeScene: string | IResolvable;

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

knowledgeType^Optional

public readonly knowledgeType: string | IResolvable;

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

metaExtractColumns^Optional

public readonly metaExtractColumns: IResolvable | IResolvable | MetaExtractColumnsProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MetaExtractColumnsProperty[]

overlapSize^Optional

public readonly overlapSize: number | IResolvable;

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

pipelineCommercialCu^Optional

public readonly pipelineCommercialCu: number | IResolvable;

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

pipelineCommercialType^Optional

public readonly pipelineCommercialType: string | IResolvable;

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

pipelineRetrieveRateLimitStrategy^Optional

public readonly pipelineRetrieveRateLimitStrategy: string | IResolvable;

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

rerankInstruct^Optional

public readonly rerankInstruct: string | IResolvable;

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

rerankMinScore^Optional

public readonly rerankMinScore: number | IResolvable;

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

rerankMode^Optional

public readonly rerankMode: string | IResolvable;

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

rerankModelName^Optional

public readonly rerankModelName: string | IResolvable;

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

separator^Optional

public readonly separator: string | IResolvable;

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

sinkInstanceId^Optional

public readonly sinkInstanceId: string | IResolvable;

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

sinkRegion^Optional

public readonly sinkRegion: string | IResolvable;

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

sinkType^Optional

public readonly sinkType: string | IResolvable;

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

sparseSimilarityTopK^Optional

public readonly sparseSimilarityTopK: number | IResolvable;

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

table^Optional

public readonly table: string | IResolvable;

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

tableIds^Optional

public readonly tableIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Constants

ROS_RESOURCE_TYPE_NAME^Required

public readonly ROS_RESOURCE_TYPE_NAME: string;

• Type: string

The resource type name for this resource class.

Structs