CfnDataSource

class aws_cdk.aws_bedrock.CfnDataSource(scope, id, *, data_source_configuration, knowledge_base_id, name, data_deletion_policy=None, description=None, server_side_encryption_configuration=None, vector_ingestion_configuration=None)

Bases: CfnResource

Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties:.

Name – Specify a name for the data source.
KnowledgeBaseId – Specify the ID of the knowledge base for the data source to belong to.
DataSourceConfiguration – Specify information about the Amazon S3 bucket containing the data source. The following sub-properties are required:
Type – Specify the value S3 .

For more information about setting up data sources in Amazon Bedrock , see Set up a data source for your knowledge base .

See the Properties section below for descriptions of both the required and optional properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-datasource.html
CloudformationResource:: AWS::Bedrock::DataSource
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

cfn_data_source = bedrock.CfnDataSource(self, "MyCfnDataSource",
    data_source_configuration=bedrock.CfnDataSource.DataSourceConfigurationProperty(
        s3_configuration=bedrock.CfnDataSource.S3DataSourceConfigurationProperty(
            bucket_arn="bucketArn",

            # the properties below are optional
            bucket_owner_account_id="bucketOwnerAccountId",
            inclusion_prefixes=["inclusionPrefixes"]
        ),
        type="type"
    ),
    knowledge_base_id="knowledgeBaseId",
    name="name",

    # the properties below are optional
    data_deletion_policy="dataDeletionPolicy",
    description="description",
    server_side_encryption_configuration=bedrock.CfnDataSource.ServerSideEncryptionConfigurationProperty(
        kms_key_arn="kmsKeyArn"
    ),
    vector_ingestion_configuration=bedrock.CfnDataSource.VectorIngestionConfigurationProperty(
        chunking_configuration=bedrock.CfnDataSource.ChunkingConfigurationProperty(
            chunking_strategy="chunkingStrategy",

            # the properties below are optional
            fixed_size_chunking_configuration=bedrock.CfnDataSource.FixedSizeChunkingConfigurationProperty(
                max_tokens=123,
                overlap_percentage=123
            )
        )
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
data_source_configuration (Union[IResolvable, DataSourceConfigurationProperty, Dict[str, Any]]) – Contains details about how the data source is stored.
knowledge_base_id (str) – The unique identifier of the knowledge base to which the data source belongs.
name (str) – The name of the data source.
data_deletion_policy (Optional[str]) – The data deletion policy for a data source.
description (Optional[str]) – The description of the data source.
server_side_encryption_configuration (Union[IResolvable, ServerSideEncryptionConfigurationProperty, Dict[str, Any], None]) – Contains details about the configuration of the server-side encryption.
vector_ingestion_configuration (Union[IResolvable, VectorIngestionConfigurationProperty, Dict[str, Any], None]) – Contains details about how to ingest the documents in the data source.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Bedrock::DataSource'

attr_created_at

The time at which the data source was created.

CloudformationAttribute:: CreatedAt

attr_data_source_id

The unique identifier of the data source.

CloudformationAttribute:: DataSourceId

attr_data_source_status

.

Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.

CloudformationAttribute:: DataSourceStatus
Type:: The status of the data source. The following statuses are possible

attr_failure_reasons

The detailed reasons on the failure to delete a data source.

CloudformationAttribute:: FailureReasons

attr_updated_at

The time at which the data source was last updated.

CloudformationAttribute:: UpdatedAt

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_deletion_policy: The data deletion policy for a data source.

data_source_configuration: Contains details about how the data source is stored.

description: The description of the data source.

knowledge_base_id: The unique identifier of the knowledge base to which the data source belongs.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the data source.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

server_side_encryption_configuration: Contains details about the configuration of the server-side encryption.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

vector_ingestion_configuration: Contains details about how to ingest the documents in the data source.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

ChunkingConfigurationProperty

class CfnDataSource.ChunkingConfigurationProperty(*, chunking_strategy, fixed_size_chunking_configuration=None)

Bases: object

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.

Parameters:

chunking_strategy (str) – 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 (Union[IResolvable, FixedSizeChunkingConfigurationProperty, Dict[str, Any], None]) – Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

chunking_configuration_property = bedrock.CfnDataSource.ChunkingConfigurationProperty(
    chunking_strategy="chunkingStrategy",

    # the properties below are optional
    fixed_size_chunking_configuration=bedrock.CfnDataSource.FixedSizeChunkingConfigurationProperty(
        max_tokens=123,
        overlap_percentage=123
    )
)

Attributes

chunking_strategy

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-chunkingstrategy

fixed_size_chunking_configuration

Configurations for when you choose fixed-size chunking.

If you set the chunkingStrategy as NONE , exclude this field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-fixedsizechunkingconfiguration

DataSourceConfigurationProperty

class CfnDataSource.DataSourceConfigurationProperty(*, s3_configuration, type)

Bases: object

Contains details about how a data source is stored.

Parameters:

s3_configuration (Union[IResolvable, S3DataSourceConfigurationProperty, Dict[str, Any]]) – Contains details about the configuration of the S3 object containing the data source.
type (str) – The type of storage for the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

data_source_configuration_property = bedrock.CfnDataSource.DataSourceConfigurationProperty(
    s3_configuration=bedrock.CfnDataSource.S3DataSourceConfigurationProperty(
        bucket_arn="bucketArn",

        # the properties below are optional
        bucket_owner_account_id="bucketOwnerAccountId",
        inclusion_prefixes=["inclusionPrefixes"]
    ),
    type="type"
)

Attributes

s3_configuration

Contains details about the configuration of the S3 object containing the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-s3configuration

type

The type of storage for the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-datasourceconfiguration.html#cfn-bedrock-datasource-datasourceconfiguration-type

FixedSizeChunkingConfigurationProperty

class CfnDataSource.FixedSizeChunkingConfigurationProperty(*, max_tokens, overlap_percentage)

Bases: object

Configurations for when you choose fixed-size chunking.

If you set the chunkingStrategy as NONE , exclude this field.

Parameters:

max_tokens (Union[int, float]) – The maximum number of tokens to include in a chunk.
overlap_percentage (Union[int, float]) – The percentage of overlap between adjacent chunks of a data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

fixed_size_chunking_configuration_property = bedrock.CfnDataSource.FixedSizeChunkingConfigurationProperty(
    max_tokens=123,
    overlap_percentage=123
)

Attributes

max_tokens

The maximum number of tokens to include in a chunk.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html#cfn-bedrock-datasource-fixedsizechunkingconfiguration-maxtokens

overlap_percentage

The percentage of overlap between adjacent chunks of a data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.html#cfn-bedrock-datasource-fixedsizechunkingconfiguration-overlappercentage

S3DataSourceConfigurationProperty

class CfnDataSource.S3DataSourceConfigurationProperty(*, bucket_arn, bucket_owner_account_id=None, inclusion_prefixes=None)

Bases: object

Contains information about the S3 configuration of the data source.

Parameters:

bucket_arn (str) – The Amazon Resource Name (ARN) of the bucket that contains the data source.
bucket_owner_account_id (Optional[str]) – The bucket account owner ID for the S3 bucket.
inclusion_prefixes (Optional[Sequence[str]]) – A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

s3_data_source_configuration_property = bedrock.CfnDataSource.S3DataSourceConfigurationProperty(
    bucket_arn="bucketArn",

    # the properties below are optional
    bucket_owner_account_id="bucketOwnerAccountId",
    inclusion_prefixes=["inclusionPrefixes"]
)

Attributes

bucket_arn

The Amazon Resource Name (ARN) of the bucket that contains the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-bucketarn

bucket_owner_account_id

The bucket account owner ID for the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-bucketowneraccountid

inclusion_prefixes

A list of S3 prefixes that define the object containing the data sources.

For more information, see Organizing objects using prefixes .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-s3datasourceconfiguration.html#cfn-bedrock-datasource-s3datasourceconfiguration-inclusionprefixes

ServerSideEncryptionConfigurationProperty

class CfnDataSource.ServerSideEncryptionConfigurationProperty(*, kms_key_arn=None)

Bases: object

Contains the configuration for server-side encryption.

Parameters:: kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the resource.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-serversideencryptionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

server_side_encryption_configuration_property = bedrock.CfnDataSource.ServerSideEncryptionConfigurationProperty(
    kms_key_arn="kmsKeyArn"
)

Attributes

kms_key_arn

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-serversideencryptionconfiguration.html#cfn-bedrock-datasource-serversideencryptionconfiguration-kmskeyarn

VectorIngestionConfigurationProperty

class CfnDataSource.VectorIngestionConfigurationProperty(*, chunking_configuration=None)

Bases: object

Contains details about how to ingest the documents in a data source.

Parameters:: chunking_configuration (Union[IResolvable, ChunkingConfigurationProperty, Dict[str, Any], None]) – 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

vector_ingestion_configuration_property = bedrock.CfnDataSource.VectorIngestionConfigurationProperty(
    chunking_configuration=bedrock.CfnDataSource.ChunkingConfigurationProperty(
        chunking_strategy="chunkingStrategy",

        # the properties below are optional
        fixed_size_chunking_configuration=bedrock.CfnDataSource.FixedSizeChunkingConfigurationProperty(
            max_tokens=123,
            overlap_percentage=123
        )
    )
)

Attributes

chunking_configuration

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-vectoringestionconfiguration.html#cfn-bedrock-datasource-vectoringestionconfiguration-chunkingconfiguration