generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs • Docs

---

@cdklabs/generative-ai-cdk-constructs / RagAppsyncStepfnOpensearch

Class: RagAppsyncStepfnOpensearch

The RagAppsyncStepfnOpensearch class.

Extends

• BaseClass

Constructors

new RagAppsyncStepfnOpensearch()

new RagAppsyncStepfnOpensearch(scope, id, props): RagAppsyncStepfnOpensearch

Constructs a new instance of the RagAppsyncStepfnOpensearch class.

Parameters

• scope: Construct

represents the scope for all the resources.

• id: string

this is a scope-unique id.

• props: RagAppsyncStepfnOpensearchProps

user provided props for the construct.

Returns

RagAppsyncStepfnOpensearch

Since

0.0.0

Overrides

BaseClass.constructor

Properties

constructUsageMetric

readonly constructUsageMetric: "uksb-1tupboc45" = 'uksb-1tupboc45'

construct usage metric , added in template description

Inherited from

BaseClass.constructUsageMetric

---

embeddingsLambdaFunction

readonly embeddingsLambdaFunction: DockerImageFunction

Returns an instance of lambda.DockerImageFunction used for the embeddings job created by the construct

---

enablexray

enablexray: boolean = true

enable disable xray tracing

Default

- True

Inherited from

BaseClass.enablexray

---

fieldLogLevel

fieldLogLevel: FieldLogLevel = appsync.FieldLogLevel.ALL

Default log config for all constructs

Inherited from

BaseClass.fieldLogLevel

---

fileTransformerLambdaFunction

readonly fileTransformerLambdaFunction: DockerImageFunction

Returns an instance of lambda.DockerImageFunction used for the file transformer job created by the construct

---

graphqlApi

readonly graphqlApi: IGraphqlApi

Returns an instance of appsync.IGraphqlApi created by the construct

---

ingestionBus

readonly ingestionBus: IEventBus

Returns the instance of events.IEventBus used by the construct

---

inputValidationLambdaFunction

readonly inputValidationLambdaFunction: DockerImageFunction

Returns an instance of lambda.DockerImageFunction used for the input validation job created by the construct

---

lambdaTracing

lambdaTracing: Tracing = lambda.Tracing.ACTIVE

enable disable lambda tracing

Default

- Active

Inherited from

BaseClass.lambdaTracing

---

node

readonly node: Node

The tree node.

Inherited from

BaseClass.node

---

retention

retention: RetentionDays = logs.RetentionDays.TEN_YEARS

Default log retention config for all constructs

Inherited from

BaseClass.retention

---

s3InputAssetsBucket?

readonly optional s3InputAssetsBucket: Bucket

Returns an instance of s3.Bucket created by the construct. IMPORTANT: If existingInputAssetsBucketObj was provided in Pattern Construct Props, this property will be undefined

---

s3InputAssetsBucketInterface

readonly s3InputAssetsBucketInterface: IBucket

Returns an instance of s3.IBucket created by the construct

---

s3ProcessedAssetsBucket?

readonly optional s3ProcessedAssetsBucket: Bucket

Returns an instance of s3.Bucket created by the construct. IMPORTANT: If existingProcessedAssetsBucketObj was provided in Pattern Construct Props, this property will be undefined

---

s3ProcessedAssetsBucketInterface

readonly s3ProcessedAssetsBucketInterface: IBucket

Returns an instance of s3.IBucket created by the construct

---

securityGroup

readonly securityGroup: ISecurityGroup

Returns the instance of ec2.ISecurityGroup used by the construct

---

stage

stage: string

Value will be appended to resources name.

Default

- _dev

Inherited from

BaseClass.stage

---

stateMachine

readonly stateMachine: StateMachine

Returns an instance of stepfn.StateMachine created by the construct

---

vpc

readonly vpc: IVpc

Returns the instance of ec2.IVpc used by the construct

---

usageMetricMap

protected static usageMetricMap: Record<string, number>

Record<string, number> , maps construct name with number of deployments

Inherited from

BaseClass.usageMetricMap

Methods

addObservabilityToConstruct()

protected addObservabilityToConstruct(props): void

Parameters

• props: BaseClassProps

Returns

void

Inherited from

BaseClass.addObservabilityToConstruct

---

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

BaseClass.toString

---

updateConstructUsageMetricCode()

protected updateConstructUsageMetricCode(props, scope, lambdaFunctions): void

Parameters

• props: BaseClassProps

• scope: Construct

• lambdaFunctions: DockerImageFunction[]

Returns

void

Inherited from

BaseClass.updateConstructUsageMetricCode

---

updateEnvSuffix()

protected updateEnvSuffix(props): void

Parameters

• props: BaseClassProps

Returns

void

Inherited from

BaseClass.updateEnvSuffix

---

isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• x: any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

BaseClass.isConstruct

This site is open source. Improve this page.