Interface ICfnDataSourceProps
Properties for defining a CfnDataSource
.
Namespace: Amazon.CDK.AwsQbusiness
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnDataSourceProps
Syntax (vb)
Public Interface ICfnDataSourceProps
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.Aws_qbusiness;
var configuration;
var cfnDataSourceProps = new CfnDataSourceProps {
ApplicationId = "applicationId",
Configuration = configuration,
DisplayName = "displayName",
IndexId = "indexId",
// the properties below are optional
Description = "description",
DocumentEnrichmentConfiguration = new DocumentEnrichmentConfigurationProperty {
InlineConfigurations = new [] { new InlineDocumentEnrichmentConfigurationProperty {
Condition = new DocumentAttributeConditionProperty {
Key = "key",
Operator = "operator",
// the properties below are optional
Value = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
},
DocumentContentOperator = "documentContentOperator",
Target = new DocumentAttributeTargetProperty {
Key = "key",
// the properties below are optional
AttributeValueOperator = "attributeValueOperator",
Value = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
}
} },
PostExtractionHookConfiguration = new HookConfigurationProperty {
InvocationCondition = new DocumentAttributeConditionProperty {
Key = "key",
Operator = "operator",
// the properties below are optional
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",
// the properties below are optional
Value = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
},
LambdaArn = "lambdaArn",
RoleArn = "roleArn",
S3BucketName = "s3BucketName"
}
},
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 | Configuration information to connect to your data source repository. |
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. |
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
System.String
Remarks
Configuration
Configuration information to connect to your data source repository.
object Configuration { get; }
Property Value
System.Object
Remarks
For configuration templates for your specific data source, see Supported connectors .
Description
A description for the data source connector.
virtual string Description { get; }
Property Value
System.String
Remarks
DisplayName
The name of the Amazon Q Business data source.
string DisplayName { get; }
Property Value
System.String
Remarks
DocumentEnrichmentConfiguration
Provides the configuration information for altering document metadata and content during the document ingestion process.
virtual object DocumentEnrichmentConfiguration { get; }
Property Value
System.Object
Remarks
IndexId
The identifier of the index the data source is attached to.
string IndexId { get; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
virtual string RoleArn { get; }
Property Value
System.String
Remarks
SyncSchedule
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.
virtual string SyncSchedule { get; }
Property Value
System.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.
Tags
A list of key-value pairs that identify or categorize the data source connector.
virtual 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: _ . : / = + -
: .
VpcConfiguration
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
virtual object VpcConfiguration { get; }
Property Value
System.Object