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

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.DataSource

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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:

    DataSourceConfiguration Pulumi.AwsNative.Bedrock.Inputs.DataSourceConfiguration
    Contains details about how the data source is stored.
    KnowledgeBaseId string
    The unique identifier of the knowledge base to which to add the data source.
    DataDeletionPolicy Pulumi.AwsNative.Bedrock.DataSourceDataDeletionPolicy
    The data deletion policy for a data source.
    Description string
    Description of the Resource.
    Name string
    The name of the data source.
    ServerSideEncryptionConfiguration Pulumi.AwsNative.Bedrock.Inputs.DataSourceServerSideEncryptionConfiguration
    Contains details about the configuration of the server-side encryption.
    VectorIngestionConfiguration Pulumi.AwsNative.Bedrock.Inputs.DataSourceVectorIngestionConfiguration
    Contains details about how to ingest the documents in the data source.
    DataSourceConfiguration DataSourceConfigurationArgs
    Contains details about how the data source is stored.
    KnowledgeBaseId string
    The unique identifier of the knowledge base to which to add the data source.
    DataDeletionPolicy DataSourceDataDeletionPolicy
    The data deletion policy for a data source.
    Description string
    Description of the Resource.
    Name string
    The name of the data source.
    ServerSideEncryptionConfiguration DataSourceServerSideEncryptionConfigurationArgs
    Contains details about the configuration of the server-side encryption.
    VectorIngestionConfiguration DataSourceVectorIngestionConfigurationArgs
    Contains details about how to ingest the documents in the data source.
    dataSourceConfiguration DataSourceConfiguration
    Contains details about how the data source is stored.
    knowledgeBaseId String
    The unique identifier of the knowledge base to which to add the data source.
    dataDeletionPolicy DataSourceDataDeletionPolicy
    The data deletion policy for a data source.
    description String
    Description of the Resource.
    name String
    The name of the data source.
    serverSideEncryptionConfiguration DataSourceServerSideEncryptionConfiguration
    Contains details about the configuration of the server-side encryption.
    vectorIngestionConfiguration DataSourceVectorIngestionConfiguration
    Contains details about how to ingest the documents in the data source.
    dataSourceConfiguration DataSourceConfiguration
    Contains details about how the data source is stored.
    knowledgeBaseId string
    The unique identifier of the knowledge base to which to add the data source.
    dataDeletionPolicy DataSourceDataDeletionPolicy
    The data deletion policy for a data source.
    description string
    Description of the Resource.
    name string
    The name of the data source.
    serverSideEncryptionConfiguration DataSourceServerSideEncryptionConfiguration
    Contains details about the configuration of the server-side encryption.
    vectorIngestionConfiguration DataSourceVectorIngestionConfiguration
    Contains details about how to ingest the documents in the data source.
    data_source_configuration DataSourceConfigurationArgs
    Contains details about how the data source is stored.
    knowledge_base_id str
    The unique identifier of the knowledge base to which to add the data source.
    data_deletion_policy DataSourceDataDeletionPolicy
    The data deletion policy for a data source.
    description str
    Description of the Resource.
    name str
    The name of the data source.
    server_side_encryption_configuration DataSourceServerSideEncryptionConfigurationArgs
    Contains details about the configuration of the server-side encryption.
    vector_ingestion_configuration DataSourceVectorIngestionConfigurationArgs
    Contains details about how to ingest the documents in the data source.
    dataSourceConfiguration Property Map
    Contains details about how the data source is stored.
    knowledgeBaseId String
    The unique identifier of the knowledge base to which to add the data source.
    dataDeletionPolicy "RETAIN" | "DELETE"
    The data deletion policy for a data source.
    description String
    Description of the Resource.
    name String
    The name of the data source.
    serverSideEncryptionConfiguration Property Map
    Contains details about the configuration of the server-side encryption.
    vectorIngestionConfiguration Property Map
    Contains details about how to ingest the documents in the data source.

    Outputs

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

    CreatedAt string
    The time at which the data source was created.
    DataSourceId string
    Identifier for a resource.
    DataSourceStatus Pulumi.AwsNative.Bedrock.DataSourceStatus
    The status of the data source. The following statuses are possible:

    • Available – The data source has been created and is ready for ingestion into the knowledge base.
    • Deleting – The data source is being deleted.
    FailureReasons List<string>
    The details of the failure reasons related to the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time at which the knowledge base was last updated.
    CreatedAt string
    The time at which the data source was created.
    DataSourceId string
    Identifier for a resource.
    DataSourceStatus DataSourceStatus
    The status of the data source. The following statuses are possible:

    • Available – The data source has been created and is ready for ingestion into the knowledge base.
    • Deleting – The data source is being deleted.
    FailureReasons []string
    The details of the failure reasons related to the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time at which the knowledge base was last updated.
    createdAt String
    The time at which the data source was created.
    dataSourceId String
    Identifier for a resource.
    dataSourceStatus DataSourceStatus
    The status of the data source. The following statuses are possible:

    • Available – The data source has been created and is ready for ingestion into the knowledge base.
    • Deleting – The data source is being deleted.
    failureReasons List<String>
    The details of the failure reasons related to the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time at which the knowledge base was last updated.
    createdAt string
    The time at which the data source was created.
    dataSourceId string
    Identifier for a resource.
    dataSourceStatus DataSourceStatus
    The status of the data source. The following statuses are possible:

    • Available – The data source has been created and is ready for ingestion into the knowledge base.
    • Deleting – The data source is being deleted.
    failureReasons string[]
    The details of the failure reasons related to the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt 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_id str
    Identifier for a resource.
    data_source_status DataSourceStatus
    The status of the data source. The following statuses are possible:

    • Available – The data source has been created and is ready for ingestion into the knowledge base.
    • Deleting – The data source is being deleted.
    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.
    createdAt String
    The time at which the data source was created.
    dataSourceId String
    Identifier for a resource.
    dataSourceStatus "AVAILABLE" | "DELETING" | "DELETE_UNSUCCESSFUL"
    The status of the data source. The following statuses are possible:

    • Available – The data source has been created and is ready for ingestion into the knowledge base.
    • Deleting – The data source is being deleted.
    failureReasons List<String>
    The details of the failure reasons related to the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time at which the knowledge base was last updated.

    Supporting Types

    DataSourceChunkingConfiguration, DataSourceChunkingConfigurationArgs

    ChunkingStrategy Pulumi.AwsNative.Bedrock.DataSourceChunkingStrategy
    Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

    • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .
    • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
    FixedSizeChunkingConfiguration Pulumi.AwsNative.Bedrock.Inputs.DataSourceFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
    ChunkingStrategy DataSourceChunkingStrategy
    Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

    • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .
    • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
    FixedSizeChunkingConfiguration DataSourceFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
    chunkingStrategy DataSourceChunkingStrategy
    Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

    • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .
    • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
    fixedSizeChunkingConfiguration DataSourceFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
    chunkingStrategy DataSourceChunkingStrategy
    Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

    • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .
    • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
    fixedSizeChunkingConfiguration DataSourceFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
    chunking_strategy DataSourceChunkingStrategy
    Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

    • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .
    • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
    fixed_size_chunking_configuration DataSourceFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
    chunkingStrategy "FIXED_SIZE" | "NONE"
    Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

    • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration .
    • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
    fixedSizeChunkingConfiguration Property Map
    Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.

    DataSourceChunkingStrategy, DataSourceChunkingStrategyArgs

    FixedSize
    FIXED_SIZE
    None
    NONE
    DataSourceChunkingStrategyFixedSize
    FIXED_SIZE
    DataSourceChunkingStrategyNone
    NONE
    FixedSize
    FIXED_SIZE
    None
    NONE
    FixedSize
    FIXED_SIZE
    None
    NONE
    FIXED_SIZE
    FIXED_SIZE
    NONE
    NONE
    "FIXED_SIZE"
    FIXED_SIZE
    "NONE"
    NONE

    DataSourceConfiguration, DataSourceConfigurationArgs

    S3Configuration Pulumi.AwsNative.Bedrock.Inputs.DataSourceS3DataSourceConfiguration
    Contains details about the configuration of the S3 object containing the data source.
    Type Pulumi.AwsNative.Bedrock.DataSourceType
    The type of storage for the data source.
    S3Configuration DataSourceS3DataSourceConfiguration
    Contains details about the configuration of the S3 object containing the data source.
    Type DataSourceType
    The type of storage for the data source.
    s3Configuration DataSourceS3DataSourceConfiguration
    Contains details about the configuration of the S3 object containing the data source.
    type DataSourceType
    The type of storage for the data source.
    s3Configuration DataSourceS3DataSourceConfiguration
    Contains details about the configuration of the S3 object containing the data source.
    type DataSourceType
    The type of storage for the data source.
    s3_configuration DataSourceS3DataSourceConfiguration
    Contains details about the configuration of the S3 object containing the data source.
    type DataSourceType
    The type of storage for the data source.
    s3Configuration Property Map
    Contains details about the configuration of the S3 object containing the data source.
    type "S3"
    The type of storage for the data source.

    DataSourceDataDeletionPolicy, DataSourceDataDeletionPolicyArgs

    Retain
    RETAIN
    Delete
    DELETE
    DataSourceDataDeletionPolicyRetain
    RETAIN
    DataSourceDataDeletionPolicyDelete
    DELETE
    Retain
    RETAIN
    Delete
    DELETE
    Retain
    RETAIN
    Delete
    DELETE
    RETAIN
    RETAIN
    DELETE
    DELETE
    "RETAIN"
    RETAIN
    "DELETE"
    DELETE

    DataSourceFixedSizeChunkingConfiguration, DataSourceFixedSizeChunkingConfigurationArgs

    MaxTokens int
    The maximum number of tokens to include in a chunk.
    OverlapPercentage int
    The percentage of overlap between adjacent chunks of a data source.
    MaxTokens int
    The maximum number of tokens to include in a chunk.
    OverlapPercentage int
    The percentage of overlap between adjacent chunks of a data source.
    maxTokens Integer
    The maximum number of tokens to include in a chunk.
    overlapPercentage Integer
    The percentage of overlap between adjacent chunks of a data source.
    maxTokens number
    The maximum number of tokens to include in a chunk.
    overlapPercentage 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.
    maxTokens Number
    The maximum number of tokens to include in a chunk.
    overlapPercentage Number
    The percentage of overlap between adjacent chunks of a data source.

    DataSourceS3DataSourceConfiguration, DataSourceS3DataSourceConfigurationArgs

    BucketArn string
    The ARN of the bucket that contains the data source.
    BucketOwnerAccountId string
    The account ID for the owner of the S3 bucket.
    InclusionPrefixes List<string>
    A list of S3 prefixes that define the object containing the data sources.
    BucketArn string
    The ARN of the bucket that contains the data source.
    BucketOwnerAccountId string
    The account ID for the owner of the S3 bucket.
    InclusionPrefixes []string
    A list of S3 prefixes that define the object containing the data sources.
    bucketArn String
    The ARN of the bucket that contains the data source.
    bucketOwnerAccountId String
    The account ID for the owner of the S3 bucket.
    inclusionPrefixes List<String>
    A list of S3 prefixes that define the object containing the data sources.
    bucketArn string
    The ARN of the bucket that contains the data source.
    bucketOwnerAccountId string
    The account ID for the owner of the S3 bucket.
    inclusionPrefixes 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_account_id str
    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.
    bucketArn String
    The ARN of the bucket that contains the data source.
    bucketOwnerAccountId String
    The account ID for the owner of the S3 bucket.
    inclusionPrefixes List<String>
    A list of S3 prefixes that define the object containing the data sources.

    DataSourceServerSideEncryptionConfiguration, DataSourceServerSideEncryptionConfigurationArgs

    KmsKeyArn string
    The ARN of the AWS KMS key used to encrypt the resource.
    KmsKeyArn string
    The ARN of the AWS KMS key used to encrypt the resource.
    kmsKeyArn String
    The ARN of the AWS KMS key used to encrypt the resource.
    kmsKeyArn string
    The ARN of the AWS KMS key used to encrypt the resource.
    kms_key_arn str
    The ARN of the AWS KMS key used to encrypt the resource.
    kmsKeyArn String
    The ARN of the AWS KMS key used to encrypt the resource.

    DataSourceStatus, DataSourceStatusArgs

    Available
    AVAILABLE
    Deleting
    DELETING
    DeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    DataSourceStatusAvailable
    AVAILABLE
    DataSourceStatusDeleting
    DELETING
    DataSourceStatusDeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    Available
    AVAILABLE
    Deleting
    DELETING
    DeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    Available
    AVAILABLE
    Deleting
    DELETING
    DeleteUnsuccessful
    DELETE_UNSUCCESSFUL
    AVAILABLE
    AVAILABLE
    DELETING
    DELETING
    DELETE_UNSUCCESSFUL
    DELETE_UNSUCCESSFUL
    "AVAILABLE"
    AVAILABLE
    "DELETING"
    DELETING
    "DELETE_UNSUCCESSFUL"
    DELETE_UNSUCCESSFUL

    DataSourceType, DataSourceTypeArgs

    S3
    S3
    DataSourceTypeS3
    S3
    S3
    S3
    S3
    S3
    S3
    S3
    "S3"
    S3

    DataSourceVectorIngestionConfiguration, DataSourceVectorIngestionConfigurationArgs

    ChunkingConfiguration Pulumi.AwsNative.Bedrock.Inputs.DataSourceChunkingConfiguration
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    ChunkingConfiguration DataSourceChunkingConfiguration
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    chunkingConfiguration DataSourceChunkingConfiguration
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    chunkingConfiguration DataSourceChunkingConfiguration
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    chunking_configuration DataSourceChunkingConfiguration
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
    chunkingConfiguration Property Map
    Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

    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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native