Class CfnDataSourcePropsMixin.DatabaseConfigurationProperty

Provides the configuration information to an Amazon Kendra supported database .

Inheritance

object

CfnDataSourcePropsMixin.DatabaseConfigurationProperty

Implements

CfnDataSourcePropsMixin.IDatabaseConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.DatabaseConfigurationProperty : CfnDataSourcePropsMixin.IDatabaseConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.DatabaseConfigurationProperty Implements CfnDataSourcePropsMixin.IDatabaseConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.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.Kendra.Mixins;

             var databaseConfigurationProperty = new DatabaseConfigurationProperty {
                 AclConfiguration = new AclConfigurationProperty {
                     AllowedGroupsColumnName = "allowedGroupsColumnName"
                 },
                 ColumnConfiguration = new ColumnConfigurationProperty {
                     ChangeDetectingColumns = new [] { "changeDetectingColumns" },
                     DocumentDataColumnName = "documentDataColumnName",
                     DocumentIdColumnName = "documentIdColumnName",
                     DocumentTitleColumnName = "documentTitleColumnName",
                     FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         DateFieldFormat = "dateFieldFormat",
                         IndexFieldName = "indexFieldName"
                     } }
                 },
                 ConnectionConfiguration = new ConnectionConfigurationProperty {
                     DatabaseHost = "databaseHost",
                     DatabaseName = "databaseName",
                     DatabasePort = 123,
                     SecretArn = "secretArn",
                     TableName = "tableName"
                 },
                 DatabaseEngineType = "databaseEngineType",
                 SqlConfiguration = new SqlConfigurationProperty {
                     QueryIdentifiersEnclosingOption = "queryIdentifiersEnclosingOption"
                 },
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Constructors

DatabaseConfigurationProperty()

Provides the configuration information to an Amazon Kendra supported database .

Properties

AclConfiguration	Information about the database column that provides information for user context filtering.
ColumnConfiguration	Information about where the index should get the document information from the database.
ConnectionConfiguration	Configuration information that's required to connect to a database.
DatabaseEngineType	The type of database engine that runs the database.
SqlConfiguration	Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
VpcConfiguration	Provides information for connecting to an Amazon VPC.

Constructors

DatabaseConfigurationProperty()

Provides the configuration information to an Amazon Kendra supported database .

public DatabaseConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.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.Kendra.Mixins;

             var databaseConfigurationProperty = new DatabaseConfigurationProperty {
                 AclConfiguration = new AclConfigurationProperty {
                     AllowedGroupsColumnName = "allowedGroupsColumnName"
                 },
                 ColumnConfiguration = new ColumnConfigurationProperty {
                     ChangeDetectingColumns = new [] { "changeDetectingColumns" },
                     DocumentDataColumnName = "documentDataColumnName",
                     DocumentIdColumnName = "documentIdColumnName",
                     DocumentTitleColumnName = "documentTitleColumnName",
                     FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         DateFieldFormat = "dateFieldFormat",
                         IndexFieldName = "indexFieldName"
                     } }
                 },
                 ConnectionConfiguration = new ConnectionConfigurationProperty {
                     DatabaseHost = "databaseHost",
                     DatabaseName = "databaseName",
                     DatabasePort = 123,
                     SecretArn = "secretArn",
                     TableName = "tableName"
                 },
                 DatabaseEngineType = "databaseEngineType",
                 SqlConfiguration = new SqlConfigurationProperty {
                     QueryIdentifiersEnclosingOption = "queryIdentifiersEnclosingOption"
                 },
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Properties

AclConfiguration

Information about the database column that provides information for user context filtering.

public object? AclConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-aclconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.IAclConfigurationProperty

ColumnConfiguration

Information about where the index should get the document information from the database.

public object? ColumnConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-columnconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.IColumnConfigurationProperty

ConnectionConfiguration

Configuration information that's required to connect to a database.

public object? ConnectionConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-connectionconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.IConnectionConfigurationProperty

DatabaseEngineType

The type of database engine that runs the database.

public string? DatabaseEngineType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-databaseenginetype

SqlConfiguration

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

public object? SqlConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-sqlconfiguration

Type union: either IResolvable or CfnDataSourcePropsMixin.ISqlConfigurationProperty

VpcConfiguration

Provides information for connecting to an Amazon VPC.

public object? VpcConfiguration { get; set; }