Class CfnDataSource
Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties:.
Implements
Inherited Members
Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataSource : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDataSource
Inherits CfnResource
Implements IInspectable
Remarks
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
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_bedrock;
var cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", new CfnDataSourceProps {
DataSourceConfiguration = new DataSourceConfigurationProperty {
S3Configuration = new S3DataSourceConfigurationProperty {
BucketArn = "bucketArn",
// the properties below are optional
BucketOwnerAccountId = "bucketOwnerAccountId",
InclusionPrefixes = new [] { "inclusionPrefixes" }
},
Type = "type"
},
KnowledgeBaseId = "knowledgeBaseId",
Name = "name",
// the properties below are optional
DataDeletionPolicy = "dataDeletionPolicy",
Description = "description",
ServerSideEncryptionConfiguration = new ServerSideEncryptionConfigurationProperty {
KmsKeyArn = "kmsKeyArn"
},
VectorIngestionConfiguration = new VectorIngestionConfigurationProperty {
ChunkingConfiguration = new ChunkingConfigurationProperty {
ChunkingStrategy = "chunkingStrategy",
// the properties below are optional
FixedSizeChunkingConfiguration = new FixedSizeChunkingConfigurationProperty {
MaxTokens = 123,
OverlapPercentage = 123
}
}
}
});
Synopsis
Constructors
CfnDataSource(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataSource(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDataSource(Construct, String, ICfnDataSourceProps) |
Properties
AttrCreatedAt | The time at which the data source was created. |
AttrDataSourceId | The unique identifier of the data source. |
AttrDataSourceStatus | The status of the data source. The following statuses are possible:. |
AttrFailureReasons | The detailed reasons on the failure to delete a data source. |
AttrUpdatedAt | The time at which the data source was last updated. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataDeletionPolicy | The data deletion policy for a data source. |
DataSourceConfiguration | Contains details about how the data source is stored. |
Description | The description of the data source. |
KnowledgeBaseId | The unique identifier of the knowledge base to which the data source belongs. |
Name | The name of the data source. |
ServerSideEncryptionConfiguration | Contains details about the configuration of the server-side encryption. |
VectorIngestionConfiguration | Contains details about how to ingest the documents in the data source. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataSource(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataSource(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataSource(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataSource(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDataSource(Construct, String, ICfnDataSourceProps)
public CfnDataSource(Construct scope, string id, ICfnDataSourceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDataSourceProps
Resource properties.
Properties
AttrCreatedAt
The time at which the data source was created.
public virtual string AttrCreatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedAt
AttrDataSourceId
The unique identifier of the data source.
public virtual string AttrDataSourceId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DataSourceId
AttrDataSourceStatus
The status of the data source. The following statuses are possible:.
public virtual string AttrDataSourceStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DataSourceStatus
AttrFailureReasons
The detailed reasons on the failure to delete a data source.
public virtual string[] AttrFailureReasons { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: FailureReasons
AttrUpdatedAt
The time at which the data source was last updated.
public virtual string AttrUpdatedAt { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdatedAt
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataDeletionPolicy
The data deletion policy for a data source.
public virtual string DataDeletionPolicy { get; set; }
Property Value
System.String
DataSourceConfiguration
Contains details about how the data source is stored.
public virtual object DataSourceConfiguration { get; set; }
Property Value
System.Object
Description
The description of the data source.
public virtual string Description { get; set; }
Property Value
System.String
KnowledgeBaseId
The unique identifier of the knowledge base to which the data source belongs.
public virtual string KnowledgeBaseId { get; set; }
Property Value
System.String
Name
The name of the data source.
public virtual string Name { get; set; }
Property Value
System.String
ServerSideEncryptionConfiguration
Contains details about the configuration of the server-side encryption.
public virtual object ServerSideEncryptionConfiguration { get; set; }
Property Value
System.Object
VectorIngestionConfiguration
Contains details about how to ingest the documents in the data source.
public virtual object VectorIngestionConfiguration { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>