AWS Native is in preview. AWS Classic is fully supported.
aws-native.bedrock.DataSource
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Definition of AWS::Bedrock::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,
data_source_configuration: Optional[DataSourceConfigurationArgs] = None,
knowledge_base_id: Optional[str] = None,
data_deletion_policy: Optional[DataSourceDataDeletionPolicy] = None,
description: Optional[str] = None,
name: Optional[str] = None,
server_side_encryption_configuration: Optional[DataSourceServerSideEncryptionConfigurationArgs] = None,
vector_ingestion_configuration: Optional[DataSourceVectorIngestionConfigurationArgs] = 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:bedrock: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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const dataSourceResource = new aws_native.bedrock.DataSource("dataSourceResource", {
dataSourceConfiguration: {
s3Configuration: {
bucketArn: "string",
bucketOwnerAccountId: "string",
inclusionPrefixes: ["string"],
},
type: aws_native.bedrock.DataSourceType.S3,
},
knowledgeBaseId: "string",
dataDeletionPolicy: aws_native.bedrock.DataSourceDataDeletionPolicy.Retain,
description: "string",
name: "string",
serverSideEncryptionConfiguration: {
kmsKeyArn: "string",
},
vectorIngestionConfiguration: {
chunkingConfiguration: {
chunkingStrategy: aws_native.bedrock.DataSourceChunkingStrategy.FixedSize,
fixedSizeChunkingConfiguration: {
maxTokens: 0,
overlapPercentage: 0,
},
},
},
});
Coming soon!
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:
- Data
Source Pulumi.Configuration Aws Native. Bedrock. Inputs. Data Source Configuration - Knowledge
Base stringId - The unique identifier of the knowledge base to which to add the data source.
- Data
Deletion Pulumi.Policy Aws Native. Bedrock. Data Source Data Deletion Policy - Description string
- Description of the Resource.
- Name string
- The name of the data source.
- Server
Side Pulumi.Encryption Configuration Aws Native. Bedrock. Inputs. Data Source Server Side Encryption Configuration - Vector
Ingestion Pulumi.Configuration Aws Native. Bedrock. Inputs. Data Source Vector Ingestion Configuration
- Data
Source DataConfiguration Source Configuration Args - Knowledge
Base stringId - The unique identifier of the knowledge base to which to add the data source.
- Data
Deletion DataPolicy Source Data Deletion Policy - Description string
- Description of the Resource.
- Name string
- The name of the data source.
- Server
Side DataEncryption Configuration Source Server Side Encryption Configuration Args - Vector
Ingestion DataConfiguration Source Vector Ingestion Configuration Args
- data
Source DataConfiguration Source Configuration - knowledge
Base StringId - The unique identifier of the knowledge base to which to add the data source.
- data
Deletion DataPolicy Source Data Deletion Policy - description String
- Description of the Resource.
- name String
- The name of the data source.
- server
Side DataEncryption Configuration Source Server Side Encryption Configuration - vector
Ingestion DataConfiguration Source Vector Ingestion Configuration
- data
Source DataConfiguration Source Configuration - knowledge
Base stringId - The unique identifier of the knowledge base to which to add the data source.
- data
Deletion DataPolicy Source Data Deletion Policy - description string
- Description of the Resource.
- name string
- The name of the data source.
- server
Side DataEncryption Configuration Source Server Side Encryption Configuration - vector
Ingestion DataConfiguration Source Vector Ingestion Configuration
- data_
source_ Dataconfiguration Source Configuration Args - knowledge_
base_ strid - The unique identifier of the knowledge base to which to add the data source.
- data_
deletion_ Datapolicy Source Data Deletion Policy - description str
- Description of the Resource.
- name str
- The name of the data source.
- server_
side_ Dataencryption_ configuration Source Server Side Encryption Configuration Args - vector_
ingestion_ Dataconfiguration Source Vector Ingestion Configuration Args
- data
Source Property MapConfiguration - knowledge
Base StringId - The unique identifier of the knowledge base to which to add the data source.
- data
Deletion "RETAIN" | "DELETE"Policy - description String
- Description of the Resource.
- name String
- The name of the data source.
- server
Side Property MapEncryption Configuration - vector
Ingestion Property MapConfiguration
Outputs
All input properties are implicitly available as output properties. Additionally, the DataSource resource produces the following output properties:
- Created
At string - The time at which the data source was created.
- Data
Source stringId - Identifier for a resource.
- Data
Source Pulumi.Status Aws Native. Bedrock. Data Source Status - Failure
Reasons List<string> - The details of the failure reasons related to the data source.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The time at which the knowledge base was last updated.
- Created
At string - The time at which the data source was created.
- Data
Source stringId - Identifier for a resource.
- Data
Source DataStatus Source Status - Failure
Reasons []string - The details of the failure reasons related to the data source.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The time at which the knowledge base was last updated.
- created
At String - The time at which the data source was created.
- data
Source StringId - Identifier for a resource.
- data
Source DataStatus Source Status - failure
Reasons List<String> - The details of the failure reasons related to the data source.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The time at which the knowledge base was last updated.
- created
At string - The time at which the data source was created.
- data
Source stringId - Identifier for a resource.
- data
Source DataStatus Source Status - failure
Reasons string[] - The details of the failure reasons related to the data source.
- id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - The time at which the knowledge base was last updated.
- created_
at str - The time at which the data source was created.
- data_
source_ strid - Identifier for a resource.
- data_
source_ Datastatus Source Status - failure_
reasons Sequence[str] - The details of the failure reasons related to the data source.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - The time at which the knowledge base was last updated.
- created
At String - The time at which the data source was created.
- data
Source StringId - Identifier for a resource.
- data
Source "AVAILABLE" | "DELETING" | "DELETE_UNSUCCESSFUL"Status - failure
Reasons List<String> - The details of the failure reasons related to the data source.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The time at which the knowledge base was last updated.
Supporting Types
DataSourceChunkingConfiguration, DataSourceChunkingConfigurationArgs
DataSourceChunkingStrategy, DataSourceChunkingStrategyArgs
- Fixed
Size - FIXED_SIZE
- None
- NONE
- Data
Source Chunking Strategy Fixed Size - FIXED_SIZE
- Data
Source Chunking Strategy None - NONE
- Fixed
Size - FIXED_SIZE
- None
- NONE
- Fixed
Size - FIXED_SIZE
- None
- NONE
- FIXED_SIZE
- FIXED_SIZE
- NONE
- NONE
- "FIXED_SIZE"
- FIXED_SIZE
- "NONE"
- NONE
DataSourceConfiguration, DataSourceConfigurationArgs
DataSourceDataDeletionPolicy, DataSourceDataDeletionPolicyArgs
- Retain
- RETAIN
- Delete
- DELETE
- Data
Source Data Deletion Policy Retain - RETAIN
- Data
Source Data Deletion Policy Delete - DELETE
- Retain
- RETAIN
- Delete
- DELETE
- Retain
- RETAIN
- Delete
- DELETE
- RETAIN
- RETAIN
- DELETE
- DELETE
- "RETAIN"
- RETAIN
- "DELETE"
- DELETE
DataSourceFixedSizeChunkingConfiguration, DataSourceFixedSizeChunkingConfigurationArgs
- Max
Tokens int - The maximum number of tokens to include in a chunk.
- Overlap
Percentage int - The percentage of overlap between adjacent chunks of a data source.
- Max
Tokens int - The maximum number of tokens to include in a chunk.
- Overlap
Percentage int - The percentage of overlap between adjacent chunks of a data source.
- max
Tokens Integer - The maximum number of tokens to include in a chunk.
- overlap
Percentage Integer - The percentage of overlap between adjacent chunks of a data source.
- max
Tokens number - The maximum number of tokens to include in a chunk.
- overlap
Percentage number - The percentage of overlap between adjacent chunks of a data source.
- max_
tokens int - The maximum number of tokens to include in a chunk.
- overlap_
percentage int - The percentage of overlap between adjacent chunks of a data source.
- max
Tokens Number - The maximum number of tokens to include in a chunk.
- overlap
Percentage Number - The percentage of overlap between adjacent chunks of a data source.
DataSourceS3DataSourceConfiguration, DataSourceS3DataSourceConfigurationArgs
- Bucket
Arn string - The ARN of the bucket that contains the data source.
- Bucket
Owner stringAccount Id - The account ID for the owner of the S3 bucket.
- Inclusion
Prefixes List<string> - A list of S3 prefixes that define the object containing the data sources.
- Bucket
Arn string - The ARN of the bucket that contains the data source.
- Bucket
Owner stringAccount Id - The account ID for the owner of the S3 bucket.
- Inclusion
Prefixes []string - A list of S3 prefixes that define the object containing the data sources.
- bucket
Arn String - The ARN of the bucket that contains the data source.
- bucket
Owner StringAccount Id - The account ID for the owner of the S3 bucket.
- inclusion
Prefixes List<String> - A list of S3 prefixes that define the object containing the data sources.
- bucket
Arn string - The ARN of the bucket that contains the data source.
- bucket
Owner stringAccount Id - The account ID for the owner of the S3 bucket.
- inclusion
Prefixes string[] - A list of S3 prefixes that define the object containing the data sources.
- bucket_
arn str - The ARN of the bucket that contains the data source.
- bucket_
owner_ straccount_ id - The account ID for the owner of the S3 bucket.
- inclusion_
prefixes Sequence[str] - A list of S3 prefixes that define the object containing the data sources.
- bucket
Arn String - The ARN of the bucket that contains the data source.
- bucket
Owner StringAccount Id - The account ID for the owner of the S3 bucket.
- inclusion
Prefixes List<String> - A list of S3 prefixes that define the object containing the data sources.
DataSourceServerSideEncryptionConfiguration, DataSourceServerSideEncryptionConfigurationArgs
- Kms
Key stringArn - The ARN of the AWS KMS key used to encrypt the resource.
- Kms
Key stringArn - The ARN of the AWS KMS key used to encrypt the resource.
- kms
Key StringArn - The ARN of the AWS KMS key used to encrypt the resource.
- kms
Key stringArn - The ARN of the AWS KMS key used to encrypt the resource.
- kms_
key_ strarn - The ARN of the AWS KMS key used to encrypt the resource.
- kms
Key StringArn - The ARN of the AWS KMS key used to encrypt the resource.
DataSourceStatus, DataSourceStatusArgs
- Available
- AVAILABLE
- Deleting
- DELETING
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- Data
Source Status Available - AVAILABLE
- Data
Source Status Deleting - DELETING
- Data
Source Status Delete Unsuccessful - DELETE_UNSUCCESSFUL
- Available
- AVAILABLE
- Deleting
- DELETING
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- Available
- AVAILABLE
- Deleting
- DELETING
- Delete
Unsuccessful - DELETE_UNSUCCESSFUL
- AVAILABLE
- AVAILABLE
- DELETING
- DELETING
- DELETE_UNSUCCESSFUL
- DELETE_UNSUCCESSFUL
- "AVAILABLE"
- AVAILABLE
- "DELETING"
- DELETING
- "DELETE_UNSUCCESSFUL"
- DELETE_UNSUCCESSFUL
DataSourceType, DataSourceTypeArgs
- S3
- S3
- Data
Source Type S3 - S3
- S3
- S3
- S3
- S3
- S3
- S3
- "S3"
- S3
DataSourceVectorIngestionConfiguration, DataSourceVectorIngestionConfigurationArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.