Interface ICfnDataSourceMixinProps

Properties for CfnDataSourcePropsMixin.

Namespace: Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface ICfnDataSourceMixinProps

Syntax (vb)

Public Interface ICfnDataSourceMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins;

             var configuration;

             var cfnDataSourceMixinProps = new CfnDataSourceMixinProps {
                 ApplicationId = "applicationId",
                 Configuration = configuration,
                 Description = "description",
                 DisplayName = "displayName",
                 DocumentEnrichmentConfiguration = new DocumentEnrichmentConfigurationProperty {
                     InlineConfigurations = new [] { new InlineDocumentEnrichmentConfigurationProperty {
                         Condition = new DocumentAttributeConditionProperty {
                             Key = "key",
                             Operator = "operator",
                             Value = new DocumentAttributeValueProperty {
                                 DateValue = "dateValue",
                                 LongValue = 123,
                                 StringListValue = new [] { "stringListValue" },
                                 StringValue = "stringValue"
                             }
                         },
                         DocumentContentOperator = "documentContentOperator",
                         Target = new DocumentAttributeTargetProperty {
                             AttributeValueOperator = "attributeValueOperator",
                             Key = "key",
                             Value = new DocumentAttributeValueProperty {
                                 DateValue = "dateValue",
                                 LongValue = 123,
                                 StringListValue = new [] { "stringListValue" },
                                 StringValue = "stringValue"
                             }
                         }
                     } },
                     PostExtractionHookConfiguration = new HookConfigurationProperty {
                         InvocationCondition = new DocumentAttributeConditionProperty {
                             Key = "key",
                             Operator = "operator",
                             Value = new DocumentAttributeValueProperty {
                                 DateValue = "dateValue",
                                 LongValue = 123,
                                 StringListValue = new [] { "stringListValue" },
                                 StringValue = "stringValue"
                             }
                         },
                         LambdaArn = "lambdaArn",
                         RoleArn = "roleArn",
                         S3BucketName = "s3BucketName"
                     },
                     PreExtractionHookConfiguration = new HookConfigurationProperty {
                         InvocationCondition = new DocumentAttributeConditionProperty {
                             Key = "key",
                             Operator = "operator",
                             Value = new DocumentAttributeValueProperty {
                                 DateValue = "dateValue",
                                 LongValue = 123,
                                 StringListValue = new [] { "stringListValue" },
                                 StringValue = "stringValue"
                             }
                         },
                         LambdaArn = "lambdaArn",
                         RoleArn = "roleArn",
                         S3BucketName = "s3BucketName"
                     }
                 },
                 IndexId = "indexId",
                 MediaExtractionConfiguration = new MediaExtractionConfigurationProperty {
                     AudioExtractionConfiguration = new AudioExtractionConfigurationProperty {
                         AudioExtractionStatus = "audioExtractionStatus"
                     },
                     ImageExtractionConfiguration = new ImageExtractionConfigurationProperty {
                         ImageExtractionStatus = "imageExtractionStatus"
                     },
                     VideoExtractionConfiguration = new VideoExtractionConfigurationProperty {
                         VideoExtractionStatus = "videoExtractionStatus"
                     }
                 },
                 RoleArn = "roleArn",
                 SyncSchedule = "syncSchedule",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Properties

ApplicationId	The identifier of the Amazon Q Business application the data source will be attached to.
Configuration	Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .
Description	A description for the data source connector.
DisplayName	The name of the Amazon Q Business data source.
DocumentEnrichmentConfiguration	Provides the configuration information for altering document metadata and content during the document ingestion process.
IndexId	The identifier of the index the data source is attached to.
MediaExtractionConfiguration	The configuration for extracting information from media in documents.
RoleArn	The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
SyncSchedule	Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.
Tags	A list of key-value pairs that identify or categorize the data source connector.
VpcConfiguration	Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

Properties

ApplicationId

The identifier of the Amazon Q Business application the data source will be attached to.

string? ApplicationId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-applicationid

Configuration

Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .

object? Configuration { get; }

Property Value

object

Remarks

You must use the JSON or YAML schema provided by Amazon Q .

The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors:

Similarly, you can find configuration templates and properties for your specific data source using the following steps:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-configuration

Description

A description for the data source connector.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-description

DisplayName

The name of the Amazon Q Business data source.

string? DisplayName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-displayname

DocumentEnrichmentConfiguration

Provides the configuration information for altering document metadata and content during the document ingestion process.

object? DocumentEnrichmentConfiguration { get; }

Property Value

object

Remarks

For more information, see Custom document enrichment .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-documentenrichmentconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.IDocumentEnrichmentConfigurationProperty

IndexId

The identifier of the index the data source is attached to.

string? IndexId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-indexid

MediaExtractionConfiguration

The configuration for extracting information from media in documents.

object? MediaExtractionConfiguration { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-mediaextractionconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.IMediaExtractionConfigurationProperty

RoleArn

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

string? RoleArn { get; }

Property Value

string

Remarks

This field is required for all connector types except custom connectors, where it is optional.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-rolearn

SyncSchedule

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.

string? SyncSchedule { get; }

Property Value

string

Remarks

If you don't set a schedule, Amazon Q Business won't periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-syncschedule

Tags

A list of key-value pairs that identify or categorize the data source connector.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-tags

: .

VpcConfiguration

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

object? VpcConfiguration { get; }

Property Value

object

Remarks

For more information, see Using Amazon VPC with Amazon Q Business connectors .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-vpcconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.IDataSourceVpcConfigurationProperty