Skip to content

Latest commit

 

History

History
459 lines (251 loc) · 9.39 KB

S3DataSource.md

File metadata and controls

459 lines (251 loc) · 9.39 KB
Raw

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / bedrock / S3DataSource

Class: S3DataSource

Sets up an S3 Data Source to be added to a knowledge base.

Extends

Constructors

new S3DataSource()

new S3DataSource(scope, id, props): S3DataSource

Parameters

scope

Construct

id

string

props

S3DataSourceProps

Returns

S3DataSource

Overrides

DataSourceNew.constructor

Properties

bucket

readonly bucket: IBucket

The bucket associated with the data source.

dataSourceId

readonly dataSourceId: string

The unique identifier of the data source.

Example

'JHUEVXUZMU'

Overrides

DataSourceNew.dataSourceId

dataSourceName

readonly dataSourceName: string

The name of the data source.

Overrides

DataSourceNew.dataSourceName

dataSourceType

readonly dataSourceType: DataSourceType

The type of data source.

Overrides

DataSourceNew.dataSourceType

env

readonly env: ResourceEnvironment

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.

Inherited from

DataSourceNew.env

kmsKey?

readonly optional kmsKey: IKey

The KMS key to use to encrypt the data source.

Overrides

DataSourceNew.kmsKey

knowledgeBase

readonly knowledgeBase: IKnowledgeBase

The knowledge base associated with the data source.

Overrides

DataSourceNew.knowledgeBase

node

readonly node: Node

The tree node.

Inherited from

DataSourceNew.node

physicalName

protected readonly physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Inherited from

DataSourceNew.physicalName

stack

readonly stack: Stack

The stack in which this resource is defined.

Inherited from

DataSourceNew.stack

Methods

_enableCrossEnvironment()

_enableCrossEnvironment(): void

Internal

Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns

void

Inherited from

DataSourceNew._enableCrossEnvironment

applyRemovalPolicy()

applyRemovalPolicy(policy): void

Apply the given removal policy to this resource

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy

RemovalPolicy

Returns

void

Inherited from

DataSourceNew.applyRemovalPolicy

formatAsCfnProps()

formatAsCfnProps(props, dataSourceConfiguration): CfnDataSourceProps

Formats the data source configuration properties for CloudFormation.

Parameters

props

DataSourceAssociationProps

dataSourceConfiguration

DataSourceConfigurationProperty

Returns

CfnDataSourceProps

Inherited from

DataSourceNew.formatAsCfnProps

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

DataSourceNew.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(arnAttr, arnComponents): string

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

Parameters

arnAttr

string

The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

arnComponents

ArnComponents

The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

Returns

string

Inherited from

DataSourceNew.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(nameAttr): string

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

Returns

string

Inherited from

DataSourceNew.getResourceNameAttribute

handleCommonPermissions()

handleCommonPermissions(props): void

Adds appropriate permissions to the KB execution role needed by the data source.

Parameters

props

DataSourceAssociationProps

Returns

void

Inherited from

DataSourceNew.handleCommonPermissions

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

DataSourceNew.toString

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

DataSourceNew.isConstruct

isOwnedResource()

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

Parameters

construct

IConstruct

Returns

boolean

Inherited from

DataSourceNew.isOwnedResource

isResource()

static isResource(construct): construct is Resource

Check whether the given construct is a Resource

Parameters

construct

IConstruct

Returns

construct is Resource

Inherited from

DataSourceNew.isResource