Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. bedrock
  5. AgentDataSource

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.46.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws

aws.bedrock.AgentDataSource

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.46.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Agents for Amazon Bedrock Data Source.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.bedrock.AgentDataSource("example", {
    knowledgeBaseId: "EMDPPAYPZI",
    name: "example",
    dataSourceConfiguration: {
        type: "S3",
        s3Configuration: {
            bucketArn: "arn:aws:s3:::example-bucket",
        },
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.bedrock.AgentDataSource("example",
    knowledge_base_id="EMDPPAYPZI",
    name="example",
    data_source_configuration={
        "type": "S3",
        "s3Configuration": {
            "bucketArn": "arn:aws:s3:::example-bucket",
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bedrock.NewAgentDataSource(ctx, "example", &bedrock.AgentDataSourceArgs{
			KnowledgeBaseId: pulumi.String("EMDPPAYPZI"),
			Name:            pulumi.String("example"),
			DataSourceConfiguration: &bedrock.AgentDataSourceDataSourceConfigurationArgs{
				Type: pulumi.String("S3"),
				S3Configuration: &bedrock.AgentDataSourceDataSourceConfigurationS3ConfigurationArgs{
					BucketArn: pulumi.String("arn:aws:s3:::example-bucket"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Bedrock.AgentDataSource("example", new()
    {
        KnowledgeBaseId = "EMDPPAYPZI",
        Name = "example",
        DataSourceConfiguration = new Aws.Bedrock.Inputs.AgentDataSourceDataSourceConfigurationArgs
        {
            Type = "S3",
            S3Configuration = new Aws.Bedrock.Inputs.AgentDataSourceDataSourceConfigurationS3ConfigurationArgs
            {
                BucketArn = "arn:aws:s3:::example-bucket",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentDataSource;
import com.pulumi.aws.bedrock.AgentDataSourceArgs;
import com.pulumi.aws.bedrock.inputs.AgentDataSourceDataSourceConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentDataSourceDataSourceConfigurationS3ConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AgentDataSource("example", AgentDataSourceArgs.builder()
            .knowledgeBaseId("EMDPPAYPZI")
            .name("example")
            .dataSourceConfiguration(AgentDataSourceDataSourceConfigurationArgs.builder()
                .type("S3")
                .s3Configuration(AgentDataSourceDataSourceConfigurationS3ConfigurationArgs.builder()
                    .bucketArn("arn:aws:s3:::example-bucket")
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:bedrock:AgentDataSource
    properties:
      knowledgeBaseId: EMDPPAYPZI
      name: example
      dataSourceConfiguration:
        type: S3
        s3Configuration:
          bucketArn: arn:aws:s3:::example-bucket

    Create AgentDataSource Resource

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

    Constructor syntax

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

@overload
def AgentDataSource(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    knowledge_base_id: Optional[str] = None,
                    data_deletion_policy: Optional[str] = None,
                    data_source_configuration: Optional[AgentDataSourceDataSourceConfigurationArgs] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    server_side_encryption_configuration: Optional[AgentDataSourceServerSideEncryptionConfigurationArgs] = None,
                    timeouts: Optional[AgentDataSourceTimeoutsArgs] = None,
                    vector_ingestion_configuration: Optional[AgentDataSourceVectorIngestionConfigurationArgs] = None)
    func NewAgentDataSource(ctx *Context, name string, args AgentDataSourceArgs, opts ...ResourceOption) (*AgentDataSource, error)
    public AgentDataSource(string name, AgentDataSourceArgs args, CustomResourceOptions? opts = null)
    public AgentDataSource(String name, AgentDataSourceArgs args)
public AgentDataSource(String name, AgentDataSourceArgs args, CustomResourceOptions options)

    type: aws:bedrock:AgentDataSource
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 AgentDataSourceArgs
    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 AgentDataSourceArgs
    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 AgentDataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentDataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentDataSourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var agentDataSourceResource = new Aws.Bedrock.AgentDataSource("agentDataSourceResource", new()
{
    KnowledgeBaseId = "string",
    DataDeletionPolicy = "string",
    DataSourceConfiguration = new Aws.Bedrock.Inputs.AgentDataSourceDataSourceConfigurationArgs
    {
        Type = "string",
        S3Configuration = new Aws.Bedrock.Inputs.AgentDataSourceDataSourceConfigurationS3ConfigurationArgs
        {
            BucketArn = "string",
            BucketOwnerAccountId = "string",
            InclusionPrefixes = new[]
            {
                "string",
            },
        },
    },
    Description = "string",
    Name = "string",
    ServerSideEncryptionConfiguration = new Aws.Bedrock.Inputs.AgentDataSourceServerSideEncryptionConfigurationArgs
    {
        KmsKeyArn = "string",
    },
    Timeouts = new Aws.Bedrock.Inputs.AgentDataSourceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    VectorIngestionConfiguration = new Aws.Bedrock.Inputs.AgentDataSourceVectorIngestionConfigurationArgs
    {
        ChunkingConfiguration = new Aws.Bedrock.Inputs.AgentDataSourceVectorIngestionConfigurationChunkingConfigurationArgs
        {
            ChunkingStrategy = "string",
            FixedSizeChunkingConfiguration = new Aws.Bedrock.Inputs.AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfigurationArgs
            {
                MaxTokens = 0,
                OverlapPercentage = 0,
            },
        },
    },
});

    example, err := bedrock.NewAgentDataSource(ctx, "agentDataSourceResource", &bedrock.AgentDataSourceArgs{
	KnowledgeBaseId:    pulumi.String("string"),
	DataDeletionPolicy: pulumi.String("string"),
	DataSourceConfiguration: &bedrock.AgentDataSourceDataSourceConfigurationArgs{
		Type: pulumi.String("string"),
		S3Configuration: &bedrock.AgentDataSourceDataSourceConfigurationS3ConfigurationArgs{
			BucketArn:            pulumi.String("string"),
			BucketOwnerAccountId: pulumi.String("string"),
			InclusionPrefixes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	ServerSideEncryptionConfiguration: &bedrock.AgentDataSourceServerSideEncryptionConfigurationArgs{
		KmsKeyArn: pulumi.String("string"),
	},
	Timeouts: &bedrock.AgentDataSourceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	VectorIngestionConfiguration: &bedrock.AgentDataSourceVectorIngestionConfigurationArgs{
		ChunkingConfiguration: &bedrock.AgentDataSourceVectorIngestionConfigurationChunkingConfigurationArgs{
			ChunkingStrategy: pulumi.String("string"),
			FixedSizeChunkingConfiguration: &bedrock.AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfigurationArgs{
				MaxTokens:         pulumi.Int(0),
				OverlapPercentage: pulumi.Int(0),
			},
		},
	},
})

    var agentDataSourceResource = new AgentDataSource("agentDataSourceResource", AgentDataSourceArgs.builder()
    .knowledgeBaseId("string")
    .dataDeletionPolicy("string")
    .dataSourceConfiguration(AgentDataSourceDataSourceConfigurationArgs.builder()
        .type("string")
        .s3Configuration(AgentDataSourceDataSourceConfigurationS3ConfigurationArgs.builder()
            .bucketArn("string")
            .bucketOwnerAccountId("string")
            .inclusionPrefixes("string")
            .build())
        .build())
    .description("string")
    .name("string")
    .serverSideEncryptionConfiguration(AgentDataSourceServerSideEncryptionConfigurationArgs.builder()
        .kmsKeyArn("string")
        .build())
    .timeouts(AgentDataSourceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .vectorIngestionConfiguration(AgentDataSourceVectorIngestionConfigurationArgs.builder()
        .chunkingConfiguration(AgentDataSourceVectorIngestionConfigurationChunkingConfigurationArgs.builder()
            .chunkingStrategy("string")
            .fixedSizeChunkingConfiguration(AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfigurationArgs.builder()
                .maxTokens(0)
                .overlapPercentage(0)
                .build())
            .build())
        .build())
    .build());

    agent_data_source_resource = aws.bedrock.AgentDataSource("agentDataSourceResource",
    knowledge_base_id="string",
    data_deletion_policy="string",
    data_source_configuration={
        "type": "string",
        "s3Configuration": {
            "bucketArn": "string",
            "bucketOwnerAccountId": "string",
            "inclusionPrefixes": ["string"],
        },
    },
    description="string",
    name="string",
    server_side_encryption_configuration={
        "kmsKeyArn": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    },
    vector_ingestion_configuration={
        "chunkingConfiguration": {
            "chunkingStrategy": "string",
            "fixedSizeChunkingConfiguration": {
                "maxTokens": 0,
                "overlapPercentage": 0,
            },
        },
    })

    const agentDataSourceResource = new aws.bedrock.AgentDataSource("agentDataSourceResource", {
    knowledgeBaseId: "string",
    dataDeletionPolicy: "string",
    dataSourceConfiguration: {
        type: "string",
        s3Configuration: {
            bucketArn: "string",
            bucketOwnerAccountId: "string",
            inclusionPrefixes: ["string"],
        },
    },
    description: "string",
    name: "string",
    serverSideEncryptionConfiguration: {
        kmsKeyArn: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
    vectorIngestionConfiguration: {
        chunkingConfiguration: {
            chunkingStrategy: "string",
            fixedSizeChunkingConfiguration: {
                maxTokens: 0,
                overlapPercentage: 0,
            },
        },
    },
});

    type: aws:bedrock:AgentDataSource
properties:
    dataDeletionPolicy: string
    dataSourceConfiguration:
        s3Configuration:
            bucketArn: string
            bucketOwnerAccountId: string
            inclusionPrefixes:
                - string
        type: string
    description: string
    knowledgeBaseId: string
    name: string
    serverSideEncryptionConfiguration:
        kmsKeyArn: string
    timeouts:
        create: string
        delete: string
    vectorIngestionConfiguration:
        chunkingConfiguration:
            chunkingStrategy: string
            fixedSizeChunkingConfiguration:
                maxTokens: 0
                overlapPercentage: 0

    AgentDataSource 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 AgentDataSource resource accepts the following input properties:

    KnowledgeBaseId string
    Unique identifier of the knowledge base to which the data source belongs.
    DataDeletionPolicy string
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    DataSourceConfiguration AgentDataSourceDataSourceConfiguration
    Details about how the data source is stored. See data_source_configuration block for details.
    Description string
    Description of the data source.
    Name string

    Name of the data source.

    The following arguments are optional:

    ServerSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfiguration
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    Timeouts AgentDataSourceTimeouts
    VectorIngestionConfiguration AgentDataSourceVectorIngestionConfiguration
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to which the data source belongs.
    DataDeletionPolicy string
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    DataSourceConfiguration AgentDataSourceDataSourceConfigurationArgs
    Details about how the data source is stored. See data_source_configuration block for details.
    Description string
    Description of the data source.
    Name string

    Name of the data source.

    The following arguments are optional:

    ServerSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfigurationArgs
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    Timeouts AgentDataSourceTimeoutsArgs
    VectorIngestionConfiguration AgentDataSourceVectorIngestionConfigurationArgs
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    knowledgeBaseId String
    Unique identifier of the knowledge base to which the data source belongs.
    dataDeletionPolicy String
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    dataSourceConfiguration AgentDataSourceDataSourceConfiguration
    Details about how the data source is stored. See data_source_configuration block for details.
    description String
    Description of the data source.
    name String

    Name of the data source.

    The following arguments are optional:

    serverSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfiguration
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts AgentDataSourceTimeouts
    vectorIngestionConfiguration AgentDataSourceVectorIngestionConfiguration
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    knowledgeBaseId string
    Unique identifier of the knowledge base to which the data source belongs.
    dataDeletionPolicy string
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    dataSourceConfiguration AgentDataSourceDataSourceConfiguration
    Details about how the data source is stored. See data_source_configuration block for details.
    description string
    Description of the data source.
    name string

    Name of the data source.

    The following arguments are optional:

    serverSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfiguration
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts AgentDataSourceTimeouts
    vectorIngestionConfiguration AgentDataSourceVectorIngestionConfiguration
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    knowledge_base_id str
    Unique identifier of the knowledge base to which the data source belongs.
    data_deletion_policy str
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    data_source_configuration AgentDataSourceDataSourceConfigurationArgs
    Details about how the data source is stored. See data_source_configuration block for details.
    description str
    Description of the data source.
    name str

    Name of the data source.

    The following arguments are optional:

    server_side_encryption_configuration AgentDataSourceServerSideEncryptionConfigurationArgs
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts AgentDataSourceTimeoutsArgs
    vector_ingestion_configuration AgentDataSourceVectorIngestionConfigurationArgs
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    knowledgeBaseId String
    Unique identifier of the knowledge base to which the data source belongs.
    dataDeletionPolicy String
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    dataSourceConfiguration Property Map
    Details about how the data source is stored. See data_source_configuration block for details.
    description String
    Description of the data source.
    name String

    Name of the data source.

    The following arguments are optional:

    serverSideEncryptionConfiguration Property Map
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts Property Map
    vectorIngestionConfiguration Property Map
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.

    Outputs

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

    DataSourceId string
    Unique identifier of the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    DataSourceId string
    Unique identifier of the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    dataSourceId String
    Unique identifier of the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    dataSourceId string
    Unique identifier of the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    data_source_id str
    Unique identifier of the data source.
    id str
    The provider-assigned unique ID for this managed resource.
    dataSourceId String
    Unique identifier of the data source.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AgentDataSource Resource

    Get an existing AgentDataSource resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AgentDataSourceState, opts?: CustomResourceOptions): AgentDataSource
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_deletion_policy: Optional[str] = None,
        data_source_configuration: Optional[AgentDataSourceDataSourceConfigurationArgs] = None,
        data_source_id: Optional[str] = None,
        description: Optional[str] = None,
        knowledge_base_id: Optional[str] = None,
        name: Optional[str] = None,
        server_side_encryption_configuration: Optional[AgentDataSourceServerSideEncryptionConfigurationArgs] = None,
        timeouts: Optional[AgentDataSourceTimeoutsArgs] = None,
        vector_ingestion_configuration: Optional[AgentDataSourceVectorIngestionConfigurationArgs] = None) -> AgentDataSource
    func GetAgentDataSource(ctx *Context, name string, id IDInput, state *AgentDataSourceState, opts ...ResourceOption) (*AgentDataSource, error)
    public static AgentDataSource Get(string name, Input<string> id, AgentDataSourceState? state, CustomResourceOptions? opts = null)
    public static AgentDataSource get(String name, Output<String> id, AgentDataSourceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataDeletionPolicy string
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    DataSourceConfiguration AgentDataSourceDataSourceConfiguration
    Details about how the data source is stored. See data_source_configuration block for details.
    DataSourceId string
    Unique identifier of the data source.
    Description string
    Description of the data source.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to which the data source belongs.
    Name string

    Name of the data source.

    The following arguments are optional:

    ServerSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfiguration
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    Timeouts AgentDataSourceTimeouts
    VectorIngestionConfiguration AgentDataSourceVectorIngestionConfiguration
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    DataDeletionPolicy string
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    DataSourceConfiguration AgentDataSourceDataSourceConfigurationArgs
    Details about how the data source is stored. See data_source_configuration block for details.
    DataSourceId string
    Unique identifier of the data source.
    Description string
    Description of the data source.
    KnowledgeBaseId string
    Unique identifier of the knowledge base to which the data source belongs.
    Name string

    Name of the data source.

    The following arguments are optional:

    ServerSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfigurationArgs
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    Timeouts AgentDataSourceTimeoutsArgs
    VectorIngestionConfiguration AgentDataSourceVectorIngestionConfigurationArgs
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    dataDeletionPolicy String
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    dataSourceConfiguration AgentDataSourceDataSourceConfiguration
    Details about how the data source is stored. See data_source_configuration block for details.
    dataSourceId String
    Unique identifier of the data source.
    description String
    Description of the data source.
    knowledgeBaseId String
    Unique identifier of the knowledge base to which the data source belongs.
    name String

    Name of the data source.

    The following arguments are optional:

    serverSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfiguration
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts AgentDataSourceTimeouts
    vectorIngestionConfiguration AgentDataSourceVectorIngestionConfiguration
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    dataDeletionPolicy string
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    dataSourceConfiguration AgentDataSourceDataSourceConfiguration
    Details about how the data source is stored. See data_source_configuration block for details.
    dataSourceId string
    Unique identifier of the data source.
    description string
    Description of the data source.
    knowledgeBaseId string
    Unique identifier of the knowledge base to which the data source belongs.
    name string

    Name of the data source.

    The following arguments are optional:

    serverSideEncryptionConfiguration AgentDataSourceServerSideEncryptionConfiguration
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts AgentDataSourceTimeouts
    vectorIngestionConfiguration AgentDataSourceVectorIngestionConfiguration
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    data_deletion_policy str
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    data_source_configuration AgentDataSourceDataSourceConfigurationArgs
    Details about how the data source is stored. See data_source_configuration block for details.
    data_source_id str
    Unique identifier of the data source.
    description str
    Description of the data source.
    knowledge_base_id str
    Unique identifier of the knowledge base to which the data source belongs.
    name str

    Name of the data source.

    The following arguments are optional:

    server_side_encryption_configuration AgentDataSourceServerSideEncryptionConfigurationArgs
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts AgentDataSourceTimeoutsArgs
    vector_ingestion_configuration AgentDataSourceVectorIngestionConfigurationArgs
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.
    dataDeletionPolicy String
    Data deletion policy for a data source. Valid values: RETAIN, DELETE.
    dataSourceConfiguration Property Map
    Details about how the data source is stored. See data_source_configuration block for details.
    dataSourceId String
    Unique identifier of the data source.
    description String
    Description of the data source.
    knowledgeBaseId String
    Unique identifier of the knowledge base to which the data source belongs.
    name String

    Name of the data source.

    The following arguments are optional:

    serverSideEncryptionConfiguration Property Map
    Details about the configuration of the server-side encryption. See server_side_encryption_configuration block for details.
    timeouts Property Map
    vectorIngestionConfiguration Property Map
    Details about the configuration of the server-side encryption. See vector_ingestion_configuration block for details.

    Supporting Types

    AgentDataSourceDataSourceConfiguration, AgentDataSourceDataSourceConfigurationArgs

    Type string
    Type of storage for the data source. Valid values: S3.
    S3Configuration AgentDataSourceDataSourceConfigurationS3Configuration
    Details about the configuration of the S3 object containing the data source. See s3_data_source_configuration block for details.
    Type string
    Type of storage for the data source. Valid values: S3.
    S3Configuration AgentDataSourceDataSourceConfigurationS3Configuration
    Details about the configuration of the S3 object containing the data source. See s3_data_source_configuration block for details.
    type String
    Type of storage for the data source. Valid values: S3.
    s3Configuration AgentDataSourceDataSourceConfigurationS3Configuration
    Details about the configuration of the S3 object containing the data source. See s3_data_source_configuration block for details.
    type string
    Type of storage for the data source. Valid values: S3.
    s3Configuration AgentDataSourceDataSourceConfigurationS3Configuration
    Details about the configuration of the S3 object containing the data source. See s3_data_source_configuration block for details.
    type str
    Type of storage for the data source. Valid values: S3.
    s3_configuration AgentDataSourceDataSourceConfigurationS3Configuration
    Details about the configuration of the S3 object containing the data source. See s3_data_source_configuration block for details.
    type String
    Type of storage for the data source. Valid values: S3.
    s3Configuration Property Map
    Details about the configuration of the S3 object containing the data source. See s3_data_source_configuration block for details.

    AgentDataSourceDataSourceConfigurationS3Configuration, AgentDataSourceDataSourceConfigurationS3ConfigurationArgs

    BucketArn string
    ARN of the bucket that contains the data source.
    BucketOwnerAccountId string
    Bucket account owner ID for the S3 bucket.
    InclusionPrefixes List<string>
    List of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
    BucketArn string
    ARN of the bucket that contains the data source.
    BucketOwnerAccountId string
    Bucket account owner ID for the S3 bucket.
    InclusionPrefixes []string
    List of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
    bucketArn String
    ARN of the bucket that contains the data source.
    bucketOwnerAccountId String
    Bucket account owner ID for the S3 bucket.
    inclusionPrefixes List<String>
    List of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
    bucketArn string
    ARN of the bucket that contains the data source.
    bucketOwnerAccountId string
    Bucket account owner ID for the S3 bucket.
    inclusionPrefixes string[]
    List of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
    bucket_arn str
    ARN of the bucket that contains the data source.
    bucket_owner_account_id str
    Bucket account owner ID for the S3 bucket.
    inclusion_prefixes Sequence[str]
    List of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
    bucketArn String
    ARN of the bucket that contains the data source.
    bucketOwnerAccountId String
    Bucket account owner ID for the S3 bucket.
    inclusionPrefixes List<String>
    List of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

    AgentDataSourceServerSideEncryptionConfiguration, AgentDataSourceServerSideEncryptionConfigurationArgs

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

    AgentDataSourceTimeouts, AgentDataSourceTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    AgentDataSourceVectorIngestionConfiguration, AgentDataSourceVectorIngestionConfigurationArgs

    ChunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfiguration
    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. See chunking_configuration block for details.
    ChunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfiguration
    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. See chunking_configuration block for details.
    chunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfiguration
    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. See chunking_configuration block for details.
    chunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfiguration
    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. See chunking_configuration block for details.
    chunking_configuration AgentDataSourceVectorIngestionConfigurationChunkingConfiguration
    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. See chunking_configuration block for details.
    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. See chunking_configuration block for details.

    AgentDataSourceVectorIngestionConfigurationChunkingConfiguration, AgentDataSourceVectorIngestionConfigurationChunkingConfigurationArgs

    ChunkingStrategy string
    Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: FIX_SIZE, NONE.
    FixedSizeChunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunking_strategy as NONE, exclude this field. See fixed_size_chunking_configuration for details.
    ChunkingStrategy string
    Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: FIX_SIZE, NONE.
    FixedSizeChunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunking_strategy as NONE, exclude this field. See fixed_size_chunking_configuration for details.
    chunkingStrategy String
    Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: FIX_SIZE, NONE.
    fixedSizeChunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunking_strategy as NONE, exclude this field. See fixed_size_chunking_configuration for details.
    chunkingStrategy string
    Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: FIX_SIZE, NONE.
    fixedSizeChunkingConfiguration AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunking_strategy as NONE, exclude this field. See fixed_size_chunking_configuration for details.
    chunking_strategy str
    Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: FIX_SIZE, NONE.
    fixed_size_chunking_configuration AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration
    Configurations for when you choose fixed-size chunking. If you set the chunking_strategy as NONE, exclude this field. See fixed_size_chunking_configuration for details.
    chunkingStrategy String
    Option for chunking your source data, either in fixed-sized chunks or as one chunk. Valid values: FIX_SIZE, NONE.
    fixedSizeChunkingConfiguration Property Map
    Configurations for when you choose fixed-size chunking. If you set the chunking_strategy as NONE, exclude this field. See fixed_size_chunking_configuration for details.

    AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfiguration, AgentDataSourceVectorIngestionConfigurationChunkingConfigurationFixedSizeChunkingConfigurationArgs

    MaxTokens int
    Maximum number of tokens to include in a chunk.
    OverlapPercentage int
    Percentage of overlap between adjacent chunks of a data source.
    MaxTokens int
    Maximum number of tokens to include in a chunk.
    OverlapPercentage int
    Percentage of overlap between adjacent chunks of a data source.
    maxTokens Integer
    Maximum number of tokens to include in a chunk.
    overlapPercentage Integer
    Percentage of overlap between adjacent chunks of a data source.
    maxTokens number
    Maximum number of tokens to include in a chunk.
    overlapPercentage number
    Percentage of overlap between adjacent chunks of a data source.
    max_tokens int
    Maximum number of tokens to include in a chunk.
    overlap_percentage int
    Percentage of overlap between adjacent chunks of a data source.
    maxTokens Number
    Maximum number of tokens to include in a chunk.
    overlapPercentage Number
    Percentage of overlap between adjacent chunks of a data source.

    Import

    Using pulumi import, import Agents for Amazon Bedrock Data Source using the data source ID and the knowledge base ID. For example:

    $ pulumi import aws:bedrock/agentDataSource:AgentDataSource example GWCMFMQF6T,EMDPPAYPZI

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.46.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws