Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. qbusiness
  5. DataSource

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.qbusiness.DataSource

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::QBusiness::DataSource Resource Type

    Create DataSource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
    @overload
def DataSource(resource_name: str,
               args: DataSourceArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def DataSource(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               application_id: Optional[str] = None,
               configuration: Optional[Any] = None,
               display_name: Optional[str] = None,
               index_id: Optional[str] = None,
               description: Optional[str] = None,
               document_enrichment_configuration: Optional[DataSourceDocumentEnrichmentConfigurationArgs] = None,
               role_arn: Optional[str] = None,
               sync_schedule: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
               vpc_configuration: Optional[DataSourceVpcConfigurationArgs] = None)
    func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
    public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
    public DataSource(String name, DataSourceArgs args)
public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)

    type: aws-native:qbusiness:DataSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DataSource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DataSource resource accepts the following input properties:

    ApplicationId string
    The identifier of the Amazon Q Business application the data source will be attached to.
    Configuration object

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    You can find configuration templates 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 of your choice.
    • Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

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

    DisplayName string
    The name of the Amazon Q Business data source.
    IndexId string
    The identifier of the index the data source is attached to.
    Description string
    A description for the data source connector.
    DocumentEnrichmentConfiguration Pulumi.AwsNative.QBusiness.Inputs.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.
    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.Inputs.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: _ . : / = + - @.
    VpcConfiguration Pulumi.AwsNative.QBusiness.Inputs.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 .
    ApplicationId string
    The identifier of the Amazon Q Business application the data source will be attached to.
    Configuration interface{}

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    You can find configuration templates 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 of your choice.
    • Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

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

    DisplayName string
    The name of the Amazon Q Business data source.
    IndexId string
    The identifier of the index the data source is attached to.
    Description string
    A description for the data source connector.
    DocumentEnrichmentConfiguration DataSourceDocumentEnrichmentConfigurationArgs

    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.
    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 TagArgs
    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: _ . : / = + - @.
    VpcConfiguration DataSourceVpcConfigurationArgs
    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 .
    applicationId String
    The identifier of the Amazon Q Business application the data source will be attached to.
    configuration Object

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    You can find configuration templates 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 of your choice.
    • Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

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

    displayName String
    The name of the Amazon Q Business data source.
    indexId String
    The identifier of the index the data source is attached to.
    description String
    A description for the data source connector.
    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.
    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: _ . : / = + - @.
    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 .
    applicationId string
    The identifier of the Amazon Q Business application the data source will be attached to.
    configuration any

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    You can find configuration templates 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 of your choice.
    • Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

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

    displayName string
    The name of the Amazon Q Business data source.
    indexId string
    The identifier of the index the data source is attached to.
    description string
    A description for the data source connector.
    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.
    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: _ . : / = + - @.
    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 .
    application_id str
    The identifier of the Amazon Q Business application the data source will be attached to.
    configuration Any

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    You can find configuration templates 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 of your choice.
    • Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

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

    display_name str
    The name of the Amazon Q Business data source.
    index_id str
    The identifier of the index the data source is attached to.
    description str
    A description for the data source connector.
    document_enrichment_configuration DataSourceDocumentEnrichmentConfigurationArgs

    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.
    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[TagArgs]
    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: _ . : / = + - @.
    vpc_configuration DataSourceVpcConfigurationArgs
    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 .
    applicationId String
    The identifier of the Amazon Q Business application the data source will be attached to.
    configuration Any

    Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

    Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

    You can find configuration templates 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 of your choice.
    • Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

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

    displayName String
    The name of the Amazon Q Business data source.
    indexId String
    The identifier of the index the data source is attached to.
    description String
    A description for the data source connector.
    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.
    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: _ . : / = + - @.
    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 .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataSource resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.QBusiness.DataSourceStatus
    The status of the Amazon Q Business data source.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status DataSourceStatus
    The status of the Amazon Q Business data source.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    The status of the Amazon Q Business data source.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    The status of the Amazon Q Business data source.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    The status of the Amazon Q Business data source.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    status "PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
    The status of the Amazon Q Business data source.
    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.

    Supporting Types

    DataSourceAttributeValueOperator, DataSourceAttributeValueOperatorArgs

    Delete
    DELETE
    DataSourceAttributeValueOperatorDelete
    DELETE
    Delete
    DELETE
    Delete
    DELETE
    DELETE
    DELETE
    "DELETE"
    DELETE

    DataSourceDocumentAttributeCondition, DataSourceDocumentAttributeConditionArgs

    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, DataSourceDocumentAttributeTargetArgs

    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, DataSourceDocumentAttributeValue0PropertiesArgs

    DataSourceDocumentAttributeValue1Properties, DataSourceDocumentAttributeValue1PropertiesArgs

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

    DataSourceDocumentAttributeValue2Properties, DataSourceDocumentAttributeValue2PropertiesArgs

    LongValue double
    LongValue float64
    longValue Double
    longValue number
    longValue Number

    DataSourceDocumentAttributeValue3Properties, DataSourceDocumentAttributeValue3PropertiesArgs

    DateValue string
    DateValue string
    dateValue String
    dateValue string
    dateValue String

    DataSourceDocumentContentOperator, DataSourceDocumentContentOperatorArgs

    Delete
    DELETE
    DataSourceDocumentContentOperatorDelete
    DELETE
    Delete
    DELETE
    Delete
    DELETE
    DELETE
    DELETE
    "DELETE"
    DELETE

    DataSourceDocumentEnrichmentConditionOperator, DataSourceDocumentEnrichmentConditionOperatorArgs

    GreaterThan
    GREATER_THAN
    GreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    LessThan
    LESS_THAN
    LessThanOrEquals
    LESS_THAN_OR_EQUALS
    EqualsValue
    EQUALS
    NotEquals
    NOT_EQUALS
    Contains
    CONTAINS
    NotContains
    NOT_CONTAINS
    Exists
    EXISTS
    NotExists
    NOT_EXISTS
    BeginsWith
    BEGINS_WITH
    DataSourceDocumentEnrichmentConditionOperatorGreaterThan
    GREATER_THAN
    DataSourceDocumentEnrichmentConditionOperatorGreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    DataSourceDocumentEnrichmentConditionOperatorLessThan
    LESS_THAN
    DataSourceDocumentEnrichmentConditionOperatorLessThanOrEquals
    LESS_THAN_OR_EQUALS
    DataSourceDocumentEnrichmentConditionOperatorEquals
    EQUALS
    DataSourceDocumentEnrichmentConditionOperatorNotEquals
    NOT_EQUALS
    DataSourceDocumentEnrichmentConditionOperatorContains
    CONTAINS
    DataSourceDocumentEnrichmentConditionOperatorNotContains
    NOT_CONTAINS
    DataSourceDocumentEnrichmentConditionOperatorExists
    EXISTS
    DataSourceDocumentEnrichmentConditionOperatorNotExists
    NOT_EXISTS
    DataSourceDocumentEnrichmentConditionOperatorBeginsWith
    BEGINS_WITH
    GreaterThan
    GREATER_THAN
    GreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    LessThan
    LESS_THAN
    LessThanOrEquals
    LESS_THAN_OR_EQUALS
    Equals
    EQUALS
    NotEquals
    NOT_EQUALS
    Contains
    CONTAINS
    NotContains
    NOT_CONTAINS
    Exists
    EXISTS
    NotExists
    NOT_EXISTS
    BeginsWith
    BEGINS_WITH
    GreaterThan
    GREATER_THAN
    GreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    LessThan
    LESS_THAN
    LessThanOrEquals
    LESS_THAN_OR_EQUALS
    Equals
    EQUALS
    NotEquals
    NOT_EQUALS
    Contains
    CONTAINS
    NotContains
    NOT_CONTAINS
    Exists
    EXISTS
    NotExists
    NOT_EXISTS
    BeginsWith
    BEGINS_WITH
    GREATER_THAN
    GREATER_THAN
    GREATER_THAN_OR_EQUALS
    GREATER_THAN_OR_EQUALS
    LESS_THAN
    LESS_THAN
    LESS_THAN_OR_EQUALS
    LESS_THAN_OR_EQUALS
    EQUALS
    EQUALS
    NOT_EQUALS
    NOT_EQUALS
    CONTAINS
    CONTAINS
    NOT_CONTAINS
    NOT_CONTAINS
    EXISTS
    EXISTS
    NOT_EXISTS
    NOT_EXISTS
    BEGINS_WITH
    BEGINS_WITH
    "GREATER_THAN"
    GREATER_THAN
    "GREATER_THAN_OR_EQUALS"
    GREATER_THAN_OR_EQUALS
    "LESS_THAN"
    LESS_THAN
    "LESS_THAN_OR_EQUALS"
    LESS_THAN_OR_EQUALS
    "EQUALS"
    EQUALS
    "NOT_EQUALS"
    NOT_EQUALS
    "CONTAINS"
    CONTAINS
    "NOT_CONTAINS"
    NOT_CONTAINS
    "EXISTS"
    EXISTS
    "NOT_EXISTS"
    NOT_EXISTS
    "BEGINS_WITH"
    BEGINS_WITH

    DataSourceDocumentEnrichmentConfiguration, DataSourceDocumentEnrichmentConfigurationArgs

    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, DataSourceHookConfigurationArgs

    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, DataSourceInlineDocumentEnrichmentConfigurationArgs

    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, DataSourceStatusArgs

    PendingCreation
    PENDING_CREATION
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    DataSourceStatusPendingCreation
    PENDING_CREATION
    DataSourceStatusCreating
    CREATING
    DataSourceStatusActive
    ACTIVE
    DataSourceStatusDeleting
    DELETING
    DataSourceStatusFailed
    FAILED
    DataSourceStatusUpdating
    UPDATING
    PendingCreation
    PENDING_CREATION
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    PendingCreation
    PENDING_CREATION
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    PENDING_CREATION
    PENDING_CREATION
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    FAILED
    FAILED
    UPDATING
    UPDATING
    "PENDING_CREATION"
    PENDING_CREATION
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "UPDATING"
    UPDATING

    DataSourceVpcConfiguration, DataSourceVpcConfigurationArgs

    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, TagArgs

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native