Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. qbusiness
  5. getDataSource

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.qbusiness.getDataSource

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::QBusiness::DataSource Resource Type

    Using getDataSource

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataSource(args: GetDataSourceArgs, opts?: InvokeOptions): Promise<GetDataSourceResult>
function getDataSourceOutput(args: GetDataSourceOutputArgs, opts?: InvokeOptions): Output<GetDataSourceResult>
    def get_data_source(application_id: Optional[str] = None,
                    data_source_id: Optional[str] = None,
                    index_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDataSourceResult
def get_data_source_output(application_id: Optional[pulumi.Input[str]] = None,
                    data_source_id: Optional[pulumi.Input[str]] = None,
                    index_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDataSourceResult]
    func LookupDataSource(ctx *Context, args *LookupDataSourceArgs, opts ...InvokeOption) (*LookupDataSourceResult, error)
func LookupDataSourceOutput(ctx *Context, args *LookupDataSourceOutputArgs, opts ...InvokeOption) LookupDataSourceResultOutput

    > Note: This function is named LookupDataSource in the Go SDK.

    public static class GetDataSource 
{
    public static Task<GetDataSourceResult> InvokeAsync(GetDataSourceArgs args, InvokeOptions? opts = null)
    public static Output<GetDataSourceResult> Invoke(GetDataSourceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDataSourceResult> getDataSource(GetDataSourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:qbusiness:getDataSource
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApplicationId string
    The identifier of the Amazon Q Business application the data source will be attached to.
    DataSourceId string
    The identifier of the Amazon Q Business data source.
    IndexId string
    The identifier of the index the data source is attached to.
    ApplicationId string
    The identifier of the Amazon Q Business application the data source will be attached to.
    DataSourceId string
    The identifier of the Amazon Q Business data source.
    IndexId string
    The identifier of the index the data source is attached to.
    applicationId String
    The identifier of the Amazon Q Business application the data source will be attached to.
    dataSourceId String
    The identifier of the Amazon Q Business data source.
    indexId String
    The identifier of the index the data source is attached to.
    applicationId string
    The identifier of the Amazon Q Business application the data source will be attached to.
    dataSourceId string
    The identifier of the Amazon Q Business data source.
    indexId string
    The identifier of the index the data source is attached to.
    application_id str
    The identifier of the Amazon Q Business application the data source will be attached to.
    data_source_id str
    The identifier of the Amazon Q Business data source.
    index_id str
    The identifier of the index the data source is attached to.
    applicationId String
    The identifier of the Amazon Q Business application the data source will be attached to.
    dataSourceId String
    The identifier of the Amazon Q Business data source.
    indexId String
    The identifier of the index the data source is attached to.

    getDataSource Result

    The following output properties are available:

    Configuration object

    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 . 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:

    • Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
    • Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.

    CreatedAt string
    The Unix timestamp when the Amazon Q Business data source was created.
    DataSourceArn string
    The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
    DataSourceId string
    The identifier of the Amazon Q Business data source.
    Description string
    A description for the data source connector.
    DisplayName string
    The name of the Amazon Q Business data source.
    DocumentEnrichmentConfiguration Pulumi.AwsNative.QBusiness.Outputs.DataSourceDocumentEnrichmentConfiguration

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

    For more information, see Custom document enrichment .

    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    Status Pulumi.AwsNative.QBusiness.DataSourceStatus
    The status of the Amazon Q Business data source.
    SyncSchedule string

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. 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 List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that identify or categorize the data source connector. 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: _ . : / = + - @.
    Type string
    The type of the Amazon Q Business data source.
    UpdatedAt string
    The Unix timestamp when the Amazon Q Business data source was last updated.
    VpcConfiguration Pulumi.AwsNative.QBusiness.Outputs.DataSourceVpcConfiguration
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .
    Configuration interface{}

    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 . 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:

    • Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
    • Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.

    CreatedAt string
    The Unix timestamp when the Amazon Q Business data source was created.
    DataSourceArn string
    The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
    DataSourceId string
    The identifier of the Amazon Q Business data source.
    Description string
    A description for the data source connector.
    DisplayName string
    The name of the Amazon Q Business data source.
    DocumentEnrichmentConfiguration DataSourceDocumentEnrichmentConfiguration

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

    For more information, see Custom document enrichment .

    RoleArn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    Status DataSourceStatus
    The status of the Amazon Q Business data source.
    SyncSchedule string

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. 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 Tag
    A list of key-value pairs that identify or categorize the data source connector. 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: _ . : / = + - @.
    Type string
    The type of the Amazon Q Business data source.
    UpdatedAt string
    The Unix timestamp when the Amazon Q Business data source was last updated.
    VpcConfiguration DataSourceVpcConfiguration
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .
    configuration Object

    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 . 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:

    • Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
    • Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.

    createdAt String
    The Unix timestamp when the Amazon Q Business data source was created.
    dataSourceArn String
    The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
    dataSourceId String
    The identifier of the Amazon Q Business data source.
    description String
    A description for the data source connector.
    displayName String
    The name of the Amazon Q Business data source.
    documentEnrichmentConfiguration DataSourceDocumentEnrichmentConfiguration

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

    For more information, see Custom document enrichment .

    roleArn String
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    status DataSourceStatus
    The status of the Amazon Q Business data source.
    syncSchedule String

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. 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 List<Tag>
    A list of key-value pairs that identify or categorize the data source connector. 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: _ . : / = + - @.
    type String
    The type of the Amazon Q Business data source.
    updatedAt String
    The Unix timestamp when the Amazon Q Business data source was last updated.
    vpcConfiguration DataSourceVpcConfiguration
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .
    configuration any

    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 . 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:

    • Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
    • Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.

    createdAt string
    The Unix timestamp when the Amazon Q Business data source was created.
    dataSourceArn string
    The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
    dataSourceId string
    The identifier of the Amazon Q Business data source.
    description string
    A description for the data source connector.
    displayName string
    The name of the Amazon Q Business data source.
    documentEnrichmentConfiguration DataSourceDocumentEnrichmentConfiguration

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

    For more information, see Custom document enrichment .

    roleArn string
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    status DataSourceStatus
    The status of the Amazon Q Business data source.
    syncSchedule string

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. 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 Tag[]
    A list of key-value pairs that identify or categorize the data source connector. 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: _ . : / = + - @.
    type string
    The type of the Amazon Q Business data source.
    updatedAt string
    The Unix timestamp when the Amazon Q Business data source was last updated.
    vpcConfiguration DataSourceVpcConfiguration
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .
    configuration Any

    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 . 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:

    • Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
    • Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.

    created_at str
    The Unix timestamp when the Amazon Q Business data source was created.
    data_source_arn str
    The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
    data_source_id str
    The identifier of the Amazon Q Business data source.
    description str
    A description for the data source connector.
    display_name str
    The name of the Amazon Q Business data source.
    document_enrichment_configuration DataSourceDocumentEnrichmentConfiguration

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

    For more information, see Custom document enrichment .

    role_arn str
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    status DataSourceStatus
    The status of the Amazon Q Business data source.
    sync_schedule str

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. 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 Sequence[root_Tag]
    A list of key-value pairs that identify or categorize the data source connector. 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: _ . : / = + - @.
    type str
    The type of the Amazon Q Business data source.
    updated_at str
    The Unix timestamp when the Amazon Q Business data source was last updated.
    vpc_configuration DataSourceVpcConfiguration
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .
    configuration Any

    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 . 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:

    • Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
    • Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.

    createdAt String
    The Unix timestamp when the Amazon Q Business data source was created.
    dataSourceArn String
    The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
    dataSourceId String
    The identifier of the Amazon Q Business data source.
    description String
    A description for the data source connector.
    displayName String
    The name of the Amazon Q Business data source.
    documentEnrichmentConfiguration Property Map

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

    For more information, see Custom document enrichment .

    roleArn String
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    status "PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
    The status of the Amazon Q Business data source.
    syncSchedule String

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. 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 List<Property Map>
    A list of key-value pairs that identify or categorize the data source connector. 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: _ . : / = + - @.
    type String
    The type of the Amazon Q Business data source.
    updatedAt String
    The Unix timestamp when the Amazon Q Business data source was last updated.
    vpcConfiguration Property Map
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .

    Supporting Types

    DataSourceAttributeValueOperator

    DataSourceDocumentAttributeCondition

    Key string

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

    Operator Pulumi.AwsNative.QBusiness.DataSourceDocumentEnrichmentConditionOperator

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

    Value Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue0Properties | Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue1Properties | Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue2Properties | Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    Key string

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

    Operator DataSourceDocumentEnrichmentConditionOperator

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

    Value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key String

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

    operator DataSourceDocumentEnrichmentConditionOperator

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

    value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key string

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

    operator DataSourceDocumentEnrichmentConditionOperator

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

    value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key str

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

    operator DataSourceDocumentEnrichmentConditionOperator

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

    value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key String

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

    operator "GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS" | "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS" | "BEGINS_WITH"

    The identifier of the document attribute used for the condition.

    For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

    Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

    value Property Map | Property Map | Property Map | Property Map
    The value of a document attribute. You can only provide one value for a document attribute.

    DataSourceDocumentAttributeTarget

    Key string
    The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
    AttributeValueOperator Pulumi.AwsNative.QBusiness.DataSourceAttributeValueOperator
    TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .
    Value Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue0Properties | Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue1Properties | Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue2Properties | Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    Key string
    The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
    AttributeValueOperator DataSourceAttributeValueOperator
    TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .
    Value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key String
    The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
    attributeValueOperator DataSourceAttributeValueOperator
    TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .
    value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key string
    The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
    attributeValueOperator DataSourceAttributeValueOperator
    TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .
    value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key str
    The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
    attribute_value_operator DataSourceAttributeValueOperator
    TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .
    value DataSourceDocumentAttributeValue0Properties | DataSourceDocumentAttributeValue1Properties | DataSourceDocumentAttributeValue2Properties | DataSourceDocumentAttributeValue3Properties
    The value of a document attribute. You can only provide one value for a document attribute.
    key String
    The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
    attributeValueOperator "DELETE"
    TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .
    value Property Map | Property Map | Property Map | Property Map
    The value of a document attribute. You can only provide one value for a document attribute.

    DataSourceDocumentAttributeValue0Properties

    DataSourceDocumentAttributeValue1Properties

    StringListValue List<string>
    stringListValue List<String>
    string_list_value Sequence[str]
    stringListValue List<String>

    DataSourceDocumentAttributeValue2Properties

    LongValue double
    LongValue float64
    longValue Double
    longValue number
    longValue Number

    DataSourceDocumentAttributeValue3Properties

    DateValue string
    DateValue string
    dateValue String
    dateValue string
    dateValue String

    DataSourceDocumentContentOperator

    DataSourceDocumentEnrichmentConditionOperator

    DataSourceDocumentEnrichmentConfiguration

    InlineConfigurations List<Pulumi.AwsNative.QBusiness.Inputs.DataSourceInlineDocumentEnrichmentConfiguration>
    Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    PostExtractionHookConfiguration Pulumi.AwsNative.QBusiness.Inputs.DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    PreExtractionHookConfiguration Pulumi.AwsNative.QBusiness.Inputs.DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    InlineConfigurations []DataSourceInlineDocumentEnrichmentConfiguration
    Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    PostExtractionHookConfiguration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    PreExtractionHookConfiguration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    inlineConfigurations List<DataSourceInlineDocumentEnrichmentConfiguration>
    Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    postExtractionHookConfiguration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    preExtractionHookConfiguration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    inlineConfigurations DataSourceInlineDocumentEnrichmentConfiguration[]
    Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    postExtractionHookConfiguration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    preExtractionHookConfiguration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    inline_configurations Sequence[DataSourceInlineDocumentEnrichmentConfiguration]
    Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    post_extraction_hook_configuration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    pre_extraction_hook_configuration DataSourceHookConfiguration
    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    inlineConfigurations List<Property Map>
    Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    postExtractionHookConfiguration Property Map
    Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .
    preExtractionHookConfiguration Property Map
    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .

    DataSourceHookConfiguration

    InvocationCondition Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeCondition

    The condition used for when a Lambda function should be invoked.

    For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

    LambdaArn string
    The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE) .
    RoleArn string
    The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    S3BucketName string
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
    InvocationCondition DataSourceDocumentAttributeCondition

    The condition used for when a Lambda function should be invoked.

    For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

    LambdaArn string
    The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE) .
    RoleArn string
    The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    S3BucketName string
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
    invocationCondition DataSourceDocumentAttributeCondition

    The condition used for when a Lambda function should be invoked.

    For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

    lambdaArn String
    The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE) .
    roleArn String
    The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    s3BucketName String
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
    invocationCondition DataSourceDocumentAttributeCondition

    The condition used for when a Lambda function should be invoked.

    For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

    lambdaArn string
    The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE) .
    roleArn string
    The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    s3BucketName string
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
    invocation_condition DataSourceDocumentAttributeCondition

    The condition used for when a Lambda function should be invoked.

    For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

    lambda_arn str
    The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE) .
    role_arn str
    The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    s3_bucket_name str
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
    invocationCondition Property Map

    The condition used for when a Lambda function should be invoked.

    For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

    lambdaArn String
    The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE) .
    roleArn String
    The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    s3BucketName String
    Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

    DataSourceInlineDocumentEnrichmentConfiguration

    Condition Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeCondition
    Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
    DocumentContentOperator Pulumi.AwsNative.QBusiness.DataSourceDocumentContentOperator
    TRUE to delete content if the condition used for the target attribute is met.
    Target Pulumi.AwsNative.QBusiness.Inputs.DataSourceDocumentAttributeTarget
    Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
    Condition DataSourceDocumentAttributeCondition
    Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
    DocumentContentOperator DataSourceDocumentContentOperator
    TRUE to delete content if the condition used for the target attribute is met.
    Target DataSourceDocumentAttributeTarget
    Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
    condition DataSourceDocumentAttributeCondition
    Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
    documentContentOperator DataSourceDocumentContentOperator
    TRUE to delete content if the condition used for the target attribute is met.
    target DataSourceDocumentAttributeTarget
    Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
    condition DataSourceDocumentAttributeCondition
    Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
    documentContentOperator DataSourceDocumentContentOperator
    TRUE to delete content if the condition used for the target attribute is met.
    target DataSourceDocumentAttributeTarget
    Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
    condition DataSourceDocumentAttributeCondition
    Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
    document_content_operator DataSourceDocumentContentOperator
    TRUE to delete content if the condition used for the target attribute is met.
    target DataSourceDocumentAttributeTarget
    Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
    condition Property Map
    Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
    documentContentOperator "DELETE"
    TRUE to delete content if the condition used for the target attribute is met.
    target Property Map
    Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.

    DataSourceStatus

    DataSourceVpcConfiguration

    SecurityGroupIds List<string>
    A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
    SubnetIds List<string>
    A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
    SecurityGroupIds []string
    A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
    SubnetIds []string
    A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
    securityGroupIds List<String>
    A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
    subnetIds List<String>
    A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
    securityGroupIds string[]
    A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
    subnetIds string[]
    A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
    security_group_ids Sequence[str]
    A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
    subnet_ids Sequence[str]
    A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
    securityGroupIds List<String>
    A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
    subnetIds List<String>
    A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native