We recommend new projects start with resources from the AWS provider.
aws-native.qbusiness.DataSource
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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,
media_extraction_configuration: Optional[DataSourceMediaExtractionConfigurationArgs] = 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataSource resource accepts the following input properties:
- Application
Id string - The identifier of the Amazon Q Business application the data source will be attached to.
- 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.- Display
Name string - The name of the Amazon Q Business data source.
- Index
Id string - The identifier of the index the data source is attached to.
- Description string
- A description for the data source connector.
- Document
Enrichment Pulumi.Configuration Aws Native. QBusiness. Inputs. Data Source Document Enrichment Configuration Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment .
- Media
Extraction Pulumi.Configuration Aws Native. QBusiness. Inputs. Data Source Media Extraction Configuration - Role
Arn string - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- Sync
Schedule 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- List<Pulumi.
Aws Native. 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: _ . : / = + - @.
- Vpc
Configuration Pulumi.Aws Native. QBusiness. Inputs. Data Source Vpc Configuration - 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 string - The identifier of the Amazon Q Business application the data source will be attached to.
- 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.- Display
Name string - The name of the Amazon Q Business data source.
- Index
Id string - The identifier of the index the data source is attached to.
- Description string
- A description for the data source connector.
- Document
Enrichment DataConfiguration Source Document Enrichment Configuration Args Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment .
- Media
Extraction DataConfiguration Source Media Extraction Configuration Args - Role
Arn string - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- Sync
Schedule 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- Tag
Args - 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 DataSource Vpc Configuration Args - 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 String - The identifier of the Amazon Q Business application the data source will be attached to.
- 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.- display
Name String - The name of the Amazon Q Business data source.
- index
Id String - The identifier of the index the data source is attached to.
- description String
- A description for the data source connector.
- document
Enrichment DataConfiguration Source Document Enrichment Configuration Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment .
- media
Extraction DataConfiguration Source Media Extraction Configuration - role
Arn String - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- sync
Schedule 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- 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: _ . : / = + - @.
- vpc
Configuration DataSource Vpc Configuration - 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 string - The identifier of the Amazon Q Business application the data source will be attached to.
- 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.- display
Name string - The name of the Amazon Q Business data source.
- index
Id string - The identifier of the index the data source is attached to.
- description string
- A description for the data source connector.
- document
Enrichment DataConfiguration Source Document Enrichment Configuration Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment .
- media
Extraction DataConfiguration Source Media Extraction Configuration - role
Arn string - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- sync
Schedule 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- 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: _ . : / = + - @.
- vpc
Configuration DataSource Vpc Configuration - 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
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.- 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_ Dataconfiguration Source Document Enrichment Configuration Args Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment .
- media_
extraction_ Dataconfiguration Source Media Extraction Configuration Args - 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- Sequence[Tag
Args] - 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 DataSource Vpc Configuration Args - 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 String - The identifier of the Amazon Q Business application the data source will be attached to.
- 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.- display
Name String - The name of the Amazon Q Business data source.
- index
Id String - The identifier of the index the data source is attached to.
- description String
- A description for the data source connector.
- document
Enrichment Property MapConfiguration Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment .
- media
Extraction Property MapConfiguration - role
Arn String - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
- sync
Schedule 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 theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- 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: _ . : / = + - @.
- vpc
Configuration 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:
- Created
At string - The Unix timestamp when the Amazon Q Business data source was created.
- Data
Source stringArn - The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- Data
Source stringId - The identifier of the Amazon Q Business data source.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. QBusiness. Data Source Status - The status of the Amazon Q Business data source.
- Type string
- The type of the Amazon Q Business data source.
- Updated
At string - The Unix timestamp when the Amazon Q Business data source was last updated.
- Created
At string - The Unix timestamp when the Amazon Q Business data source was created.
- Data
Source stringArn - The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- Data
Source stringId - The identifier of the Amazon Q Business data source.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Data
Source Status - The status of the Amazon Q Business data source.
- Type string
- The type of the Amazon Q Business data source.
- Updated
At string - The Unix timestamp when the Amazon Q Business data source was last updated.
- created
At String - The Unix timestamp when the Amazon Q Business data source was created.
- data
Source StringArn - The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- data
Source StringId - The identifier of the Amazon Q Business data source.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Data
Source Status - The status of the Amazon Q Business data source.
- type String
- The type of the Amazon Q Business data source.
- updated
At String - The Unix timestamp when the Amazon Q Business data source was last updated.
- created
At string - The Unix timestamp when the Amazon Q Business data source was created.
- data
Source stringArn - The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- data
Source stringId - The identifier of the Amazon Q Business data source.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Data
Source Status - The status of the Amazon Q Business data source.
- type string
- The type of the Amazon Q Business data source.
- updated
At 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_ strarn - The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- data_
source_ strid - The identifier of the Amazon Q Business data source.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Data
Source Status - 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.
- created
At String - The Unix timestamp when the Amazon Q Business data source was created.
- data
Source StringArn - The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
- data
Source StringId - 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.
- updated
At String - The Unix timestamp when the Amazon Q Business data source was last updated.
Supporting Types
DataSourceAttributeValueOperator, DataSourceAttributeValueOperatorArgs
- Delete
- DELETE
- Data
Source Attribute Value Operator Delete - 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.
Aws Native. QBusiness. Data Source Document Enrichment Condition Operator 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.
Aws | Pulumi.Native. QBusiness. Inputs. Data Source Document Attribute Value0Properties Aws | Pulumi.Native. QBusiness. Inputs. Data Source Document Attribute Value1Properties Aws | Pulumi.Native. QBusiness. Inputs. Data Source Document Attribute Value2Properties Aws Native. QBusiness. Inputs. Data Source Document Attribute Value3Properties - 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
Data
Source Document Enrichment Condition Operator 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
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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
Data
Source Document Enrichment Condition Operator 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
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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
Data
Source Document Enrichment Condition Operator 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
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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
Data
Source Document Enrichment Condition Operator 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
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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.
- Attribute
Value Pulumi.Operator Aws Native. QBusiness. Data Source Attribute Value Operator TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- Value
Pulumi.
Aws | Pulumi.Native. QBusiness. Inputs. Data Source Document Attribute Value0Properties Aws | Pulumi.Native. QBusiness. Inputs. Data Source Document Attribute Value1Properties Aws | Pulumi.Native. QBusiness. Inputs. Data Source Document Attribute Value2Properties Aws Native. QBusiness. Inputs. Data Source Document Attribute Value3Properties - 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.
- Attribute
Value DataOperator Source Attribute Value Operator TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- Value
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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.
- attribute
Value DataOperator Source Attribute Value Operator TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- value
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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.
- attribute
Value DataOperator Source Attribute Value Operator TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- value
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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_ Dataoperator Source Attribute Value Operator TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- value
Data
Source | DataDocument Attribute Value0Properties Source | DataDocument Attribute Value1Properties Source | DataDocument Attribute Value2Properties Source Document Attribute Value3Properties - 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.
- attribute
Value "DELETE"Operator TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
.- 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
- String
Value string
- String
Value string
- string
Value String
- string
Value string
- string_
value str
- string
Value String
DataSourceDocumentAttributeValue1Properties, DataSourceDocumentAttributeValue1PropertiesArgs
- String
List List<string>Value
- String
List []stringValue
- string
List List<String>Value
- string
List string[]Value
- string_
list_ Sequence[str]value
- string
List List<String>Value
DataSourceDocumentAttributeValue2Properties, DataSourceDocumentAttributeValue2PropertiesArgs
- Long
Value double
- Long
Value float64
- long
Value Double
- long
Value number
- long_
value float
- long
Value Number
DataSourceDocumentAttributeValue3Properties, DataSourceDocumentAttributeValue3PropertiesArgs
- Date
Value string
- Date
Value string
- date
Value String
- date
Value string
- date_
value str
- date
Value String
DataSourceDocumentContentOperator, DataSourceDocumentContentOperatorArgs
- Delete
- DELETE
- Data
Source Document Content Operator Delete - DELETE
- Delete
- DELETE
- Delete
- DELETE
- DELETE
- DELETE
- "DELETE"
- DELETE
DataSourceDocumentEnrichmentConditionOperator, DataSourceDocumentEnrichmentConditionOperatorArgs
- 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
Value - EQUALS
- Not
Equals - NOT_EQUALS
- Contains
- CONTAINS
- Not
Contains - NOT_CONTAINS
- Exists
- EXISTS
- Not
Exists - NOT_EXISTS
- Begins
With - BEGINS_WITH
- Data
Source Document Enrichment Condition Operator Greater Than - GREATER_THAN
- Data
Source Document Enrichment Condition Operator Greater Than Or Equals - GREATER_THAN_OR_EQUALS
- Data
Source Document Enrichment Condition Operator Less Than - LESS_THAN
- Data
Source Document Enrichment Condition Operator Less Than Or Equals - LESS_THAN_OR_EQUALS
- Data
Source Document Enrichment Condition Operator Equals - EQUALS
- Data
Source Document Enrichment Condition Operator Not Equals - NOT_EQUALS
- Data
Source Document Enrichment Condition Operator Contains - CONTAINS
- Data
Source Document Enrichment Condition Operator Not Contains - NOT_CONTAINS
- Data
Source Document Enrichment Condition Operator Exists - EXISTS
- Data
Source Document Enrichment Condition Operator Not Exists - NOT_EXISTS
- Data
Source Document Enrichment Condition Operator 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
- 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
- "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
- Inline
Configurations List<Pulumi.Aws Native. QBusiness. Inputs. Data Source Inline Document Enrichment Configuration> - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- Post
Extraction Pulumi.Hook Configuration Aws Native. QBusiness. Inputs. Data Source Hook Configuration - 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 Pulumi.Hook Configuration Aws Native. QBusiness. Inputs. Data Source Hook Configuration - 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 []DataSource Inline Document Enrichment Configuration - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- Post
Extraction DataHook Configuration Source Hook Configuration - 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 DataHook Configuration Source Hook Configuration - 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 List<DataSource Inline Document Enrichment Configuration> - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- post
Extraction DataHook Configuration Source Hook Configuration - 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 DataHook Configuration Source Hook Configuration - 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 DataSource Inline Document Enrichment Configuration[] - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- post
Extraction DataHook Configuration Source Hook Configuration - 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 DataHook Configuration Source Hook Configuration - 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[DataSource Inline Document Enrichment Configuration] - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- post_
extraction_ Datahook_ configuration Source Hook Configuration - 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_ Datahook_ configuration Source Hook Configuration - 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 List<Property Map> - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
- post
Extraction Property MapHook Configuration - 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 Property MapHook Configuration - 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
- Invocation
Condition Pulumi.Aws Native. QBusiness. Inputs. Data Source Document Attribute Condition 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 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) .
- Role
Arn string - The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - S3Bucket
Name 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 DataSource Document Attribute Condition 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 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) .
- Role
Arn string - The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - S3Bucket
Name 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 DataSource Document Attribute Condition 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 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) .
- role
Arn String - The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - s3Bucket
Name 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 DataSource Document Attribute Condition 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 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) .
- role
Arn string - The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - s3Bucket
Name 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 DataSource Document Attribute Condition 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
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - s3_
bucket_ strname - 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 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.
- lambda
Arn 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) .
- role
Arn String - The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. - s3Bucket
Name 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 .
DataSourceImageExtractionConfiguration, DataSourceImageExtractionConfigurationArgs
DataSourceImageExtractionStatus, DataSourceImageExtractionStatusArgs
- Enabled
- ENABLED
- Disabled
- DISABLED
- Data
Source Image Extraction Status Enabled - ENABLED
- Data
Source Image Extraction Status Disabled - DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
DataSourceInlineDocumentEnrichmentConfiguration, DataSourceInlineDocumentEnrichmentConfigurationArgs
- Condition
Pulumi.
Aws Native. QBusiness. Inputs. Data Source Document Attribute Condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
- Document
Content Pulumi.Operator Aws Native. QBusiness. Data Source Document Content Operator TRUE
to delete content if the condition used for the target attribute is met.- Target
Pulumi.
Aws Native. QBusiness. Inputs. Data Source Document Attribute Target - Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
- Condition
Data
Source Document Attribute Condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
- Document
Content DataOperator Source Document Content Operator TRUE
to delete content if the condition used for the target attribute is met.- Target
Data
Source Document Attribute Target - Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
- condition
Data
Source Document Attribute Condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
- document
Content DataOperator Source Document Content Operator TRUE
to delete content if the condition used for the target attribute is met.- target
Data
Source Document Attribute Target - Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
- condition
Data
Source Document Attribute Condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
- document
Content DataOperator Source Document Content Operator TRUE
to delete content if the condition used for the target attribute is met.- target
Data
Source Document Attribute Target - Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
- condition
Data
Source Document Attribute Condition - Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
- document_
content_ Dataoperator Source Document Content Operator TRUE
to delete content if the condition used for the target attribute is met.- target
Data
Source Document Attribute Target - 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 .
- document
Content "DELETE"Operator 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.
DataSourceMediaExtractionConfiguration, DataSourceMediaExtractionConfigurationArgs
DataSourceStatus, DataSourceStatusArgs
- Pending
Creation - PENDING_CREATION
- Creating
- CREATING
- Active
- ACTIVE
- Deleting
- DELETING
- Failed
- FAILED
- Updating
- UPDATING
- Data
Source Status Pending Creation - PENDING_CREATION
- Data
Source Status Creating - CREATING
- Data
Source Status Active - ACTIVE
- Data
Source Status Deleting - DELETING
- Data
Source Status Failed - FAILED
- Data
Source Status 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
- 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
- Security
Group List<string>Ids - 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 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.
- Security
Group []stringIds - 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 []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 List<String>Ids - 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 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.
- security
Group string[]Ids - 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 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_ Sequence[str]ids - 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.
- security
Group List<String>Ids - 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 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.