class CfnDataSourcePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnDataSourcePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnDataSourcePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnDataSourcePropsMixin
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnDataSourcePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnDataSourcePropsMixin

Implements IMixin

Extends Mixin

Properties with __Update requires: Replacement__ can result in the creation of a new data source and deletion of the old one.

This can happen if you also change the Name of the data source.

Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties:

• Name – Specify a name for the data source.

• KnowledgeBaseId – Specify the ID of the knowledge base for the data source to belong to.

• DataSourceConfiguration – Specify information about the Amazon S3 bucket containing the data source. The following sub-properties are required:

• Type – Specify the value S3 .

For more information about setting up data sources in Amazon Bedrock , see Set up a data source for your knowledge base .

See the Properties section below for descriptions of both the required and optional properties.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const cfnDataSourcePropsMixin = new bedrock_mixins.CfnDataSourcePropsMixin({
  dataDeletionPolicy: 'dataDeletionPolicy',
  dataSourceConfiguration: {
    confluenceConfiguration: {
      crawlerConfiguration: {
        filterConfiguration: {
          patternObjectFilter: {
            filters: [{
              exclusionFilters: ['exclusionFilters'],
              inclusionFilters: ['inclusionFilters'],
              objectType: 'objectType',
            }],
          },
          type: 'type',
        },
      },
      sourceConfiguration: {
        authType: 'authType',
        credentialsSecretArn: 'credentialsSecretArn',
        hostType: 'hostType',
        hostUrl: 'hostUrl',
      },
    },
    s3Configuration: {
      bucketArn: 'bucketArn',
      bucketOwnerAccountId: 'bucketOwnerAccountId',
      inclusionPrefixes: ['inclusionPrefixes'],
    },
    salesforceConfiguration: {
      crawlerConfiguration: {
        filterConfiguration: {
          patternObjectFilter: {
            filters: [{
              exclusionFilters: ['exclusionFilters'],
              inclusionFilters: ['inclusionFilters'],
              objectType: 'objectType',
            }],
          },
          type: 'type',
        },
      },
      sourceConfiguration: {
        authType: 'authType',
        credentialsSecretArn: 'credentialsSecretArn',
        hostUrl: 'hostUrl',
      },
    },
    sharePointConfiguration: {
      crawlerConfiguration: {
        filterConfiguration: {
          patternObjectFilter: {
            filters: [{
              exclusionFilters: ['exclusionFilters'],
              inclusionFilters: ['inclusionFilters'],
              objectType: 'objectType',
            }],
          },
          type: 'type',
        },
      },
      sourceConfiguration: {
        authType: 'authType',
        credentialsSecretArn: 'credentialsSecretArn',
        domain: 'domain',
        hostType: 'hostType',
        siteUrls: ['siteUrls'],
        tenantId: 'tenantId',
      },
    },
    type: 'type',
    webConfiguration: {
      crawlerConfiguration: {
        crawlerLimits: {
          maxPages: 123,
          rateLimit: 123,
        },
        exclusionFilters: ['exclusionFilters'],
        inclusionFilters: ['inclusionFilters'],
        scope: 'scope',
        userAgent: 'userAgent',
        userAgentHeader: 'userAgentHeader',
      },
      sourceConfiguration: {
        urlConfiguration: {
          seedUrls: [{
            url: 'url',
          }],
        },
      },
    },
  },
  description: 'description',
  knowledgeBaseId: 'knowledgeBaseId',
  name: 'name',
  serverSideEncryptionConfiguration: {
    kmsKeyArn: 'kmsKeyArn',
  },
  vectorIngestionConfiguration: {
    chunkingConfiguration: {
      chunkingStrategy: 'chunkingStrategy',
      fixedSizeChunkingConfiguration: {
        maxTokens: 123,
        overlapPercentage: 123,
      },
      hierarchicalChunkingConfiguration: {
        levelConfigurations: [{
          maxTokens: 123,
        }],
        overlapTokens: 123,
      },
      semanticChunkingConfiguration: {
        breakpointPercentileThreshold: 123,
        bufferSize: 123,
        maxTokens: 123,
      },
    },
    contextEnrichmentConfiguration: {
      bedrockFoundationModelConfiguration: {
        enrichmentStrategyConfiguration: {
          method: 'method',
        },
        modelArn: 'modelArn',
      },
      type: 'type',
    },
    customTransformationConfiguration: {
      intermediateStorage: {
        s3Location: {
          uri: 'uri',
        },
      },
      transformations: [{
        stepToApply: 'stepToApply',
        transformationFunction: {
          transformationLambdaConfiguration: {
            lambdaArn: 'lambdaArn',
          },
        },
      }],
    },
    parsingConfiguration: {
      bedrockDataAutomationConfiguration: {
        parsingModality: 'parsingModality',
      },
      bedrockFoundationModelConfiguration: {
        modelArn: 'modelArn',
        parsingModality: 'parsingModality',
        parsingPrompt: {
          parsingPromptText: 'parsingPromptText',
        },
      },
      parsingStrategy: 'parsingStrategy',
    },
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDataSourcePropsMixin(props: CfnDataSourceMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDataSourceMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Bedrock::DataSource.

Properties

Name	Type	Description
props	CfnDataSourceMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDataSourceMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.