Class: Aws::QBusiness::Types::CreateDataSourceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application the data source will be attached to.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Hash, ...

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the data source connector.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A name for the data source connector.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_enrichment_configuration ⇒ Types::DocumentEnrichmentConfiguration

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

For more information, see Custom document enrichment.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index that you want to use with the data source connector.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#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 the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

Returns:

  • (String) 


1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::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: _ . : / = + - @.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::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.

Returns:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1379

class CreateDataSourceRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :configuration,
  :vpc_configuration,
  :description,
  :tags,
  :sync_schedule,
  :role_arn,
  :client_token,
  :document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end