Class CfnDataSource
Creates a data source connector for an Amazon Q Business application.
Inherited Members
Namespace: Amazon.CDK.AwsQbusiness
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSource : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnDataSource
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html
CloudformationResource: AWS::QBusiness::DataSource
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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", 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
Constructors
CfnDataSource(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataSource(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDataSource(Construct, String, ICfnDataSourceProps) |
Properties
ApplicationId | The identifier of the Amazon Q Business application the data source will be attached to. |
AttrCreatedAt | The Unix timestamp when the Amazon Q Business data source was created. |
AttrDataSourceArn | The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application. |
AttrDataSourceId | The identifier of the Amazon Q Business data source. |
AttrStatus | The status of the Amazon Q Business data source. |
AttrType | The type of the Amazon Q Business data source. |
AttrUpdatedAt | The Unix timestamp when the Amazon Q Business data source was last updated. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataSource(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataSource(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataSource(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataSource(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDataSource(Construct, String, ICfnDataSourceProps)
public CfnDataSource(Construct scope, string id, ICfnDataSourceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDataSourceProps
Resource properties.
Properties
ApplicationId
The identifier of the Amazon Q Business application the data source will be attached to.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrCreatedAt
The Unix timestamp when the Amazon Q Business data source was created.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrDataSourceArn
The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
public virtual string AttrDataSourceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DataSourceArn
AttrDataSourceId
The identifier of the Amazon Q Business data source.
public virtual string AttrDataSourceId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DataSourceId
AttrStatus
The status of the Amazon Q Business data source.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
AttrType
The type of the Amazon Q Business data source.
public virtual string AttrType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Type
AttrUpdatedAt
The Unix timestamp when the Amazon Q Business data source was last updated.
public virtual string AttrUpdatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdatedAt
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Configuration
Configuration information to connect to your data source repository.
public virtual object Configuration { get; set; }
Property Value
System.Object
Description
A description for the data source connector.
public virtual string Description { get; set; }
Property Value
System.String
DisplayName
The name of the Amazon Q Business data source.
public virtual string DisplayName { get; set; }
Property Value
System.String
DocumentEnrichmentConfiguration
Provides the configuration information for altering document metadata and content during the document ingestion process.
public virtual object DocumentEnrichmentConfiguration { get; set; }
Property Value
System.Object
IndexId
The identifier of the index the data source is attached to.
public virtual string IndexId { get; set; }
Property Value
System.String
RoleArn
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
public virtual string RoleArn { get; set; }
Property Value
System.String
SyncSchedule
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.
public virtual string SyncSchedule { get; set; }
Property Value
System.String
Tags
A list of key-value pairs that identify or categorize the data source connector.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
VpcConfiguration
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
public virtual object VpcConfiguration { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>