CfnKnowledgeBase L1 construct
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
Name – Specify a name for the knowledge base.
RoleArn – Specify the Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. For more information, see Create a service role for Knowledge base for Amazon Bedrock .
KnowledgeBaseConfiguration – Specify the embeddings configuration of the knowledge base. The following sub-properties are required:
Type – Specify the value
VECTOR.StorageConfiguration – Specify information about the vector store in which the data source is stored. The following sub-properties are required:
Type – Specify the vector store service that you are using.
Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
declare const modelConfiguration: any;
const cfnKnowledgeBase = new bedrock.CfnKnowledgeBase(this, 'MyCfnKnowledgeBase', {
knowledgeBaseConfiguration: {
type: 'type',
// the properties below are optional
kendraKnowledgeBaseConfiguration: {
kendraIndexArn: 'kendraIndexArn',
},
managedKnowledgeBaseConfiguration: {
embeddingModelArn: 'embeddingModelArn',
embeddingModelConfiguration: {
bedrockEmbeddingModelConfiguration: {
audio: [{
segmentationConfiguration: {
fixedLengthDuration: 123,
},
}],
dimensions: 123,
embeddingDataType: 'embeddingDataType',
modelConfiguration: modelConfiguration,
video: [{
segmentationConfiguration: {
fixedLengthDuration: 123,
},
}],
},
},
embeddingModelType: 'embeddingModelType',
serverSideEncryptionConfiguration: {
kmsKeyArn: 'kmsKeyArn',
},
supplementalDataStorageConfiguration: {
supplementalDataStorageLocations: [{
supplementalDataStorageLocationType: 'supplementalDataStorageLocationType',
// the properties below are optional
s3Location: {
uri: 'uri',
},
}],
},
},
sqlKnowledgeBaseConfiguration: {
type: 'type',
// the properties below are optional
redshiftConfiguration: {
queryEngineConfiguration: {
type: 'type',
// the properties below are optional
provisionedConfiguration: {
authConfiguration: {
type: 'type',
// the properties below are optional
databaseUser: 'databaseUser',
usernamePasswordSecretArn: 'usernamePasswordSecretArn',
},
clusterIdentifier: 'clusterIdentifier',
},
serverlessConfiguration: {
authConfiguration: {
type: 'type',
// the properties below are optional
usernamePasswordSecretArn: 'usernamePasswordSecretArn',
},
workgroupArn: 'workgroupArn',
},
},
storageConfigurations: [{
type: 'type',
// the properties below are optional
awsDataCatalogConfiguration: {
tableNames: ['tableNames'],
},
redshiftConfiguration: {
databaseName: 'databaseName',
},
}],
// the properties below are optional
queryGenerationConfiguration: {
executionTimeoutSeconds: 123,
generationContext: {
curatedQueries: [{
naturalLanguage: 'naturalLanguage',
sql: 'sql',
}],
tables: [{
name: 'name',
// the properties below are optional
columns: [{
description: 'description',
inclusion: 'inclusion',
name: 'name',
}],
description: 'description',
inclusion: 'inclusion',
}],
},
},
},
},
vectorKnowledgeBaseConfiguration: {
embeddingModelArn: 'embeddingModelArn',
// the properties below are optional
embeddingModelConfiguration: {
bedrockEmbeddingModelConfiguration: {
audio: [{
segmentationConfiguration: {
fixedLengthDuration: 123,
},
}],
dimensions: 123,
embeddingDataType: 'embeddingDataType',
modelConfiguration: modelConfiguration,
video: [{
segmentationConfiguration: {
fixedLengthDuration: 123,
},
}],
},
},
supplementalDataStorageConfiguration: {
supplementalDataStorageLocations: [{
supplementalDataStorageLocationType: 'supplementalDataStorageLocationType',
// the properties below are optional
s3Location: {
uri: 'uri',
},
}],
},
},
},
name: 'name',
roleArn: 'roleArn',
// the properties below are optional
description: 'description',
storageConfiguration: {
type: 'type',
// the properties below are optional
mongoDbAtlasConfiguration: {
collectionName: 'collectionName',
credentialsSecretArn: 'credentialsSecretArn',
databaseName: 'databaseName',
endpoint: 'endpoint',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
vectorField: 'vectorField',
},
vectorIndexName: 'vectorIndexName',
// the properties below are optional
endpointServiceName: 'endpointServiceName',
textIndexName: 'textIndexName',
},
neptuneAnalyticsConfiguration: {
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
},
graphArn: 'graphArn',
},
opensearchManagedClusterConfiguration: {
domainArn: 'domainArn',
domainEndpoint: 'domainEndpoint',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
vectorField: 'vectorField',
},
vectorIndexName: 'vectorIndexName',
},
opensearchServerlessConfiguration: {
collectionArn: 'collectionArn',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
vectorField: 'vectorField',
},
vectorIndexName: 'vectorIndexName',
},
pineconeConfiguration: {
connectionString: 'connectionString',
credentialsSecretArn: 'credentialsSecretArn',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
},
// the properties below are optional
namespace: 'namespace',
},
rdsConfiguration: {
credentialsSecretArn: 'credentialsSecretArn',
databaseName: 'databaseName',
fieldMapping: {
metadataField: 'metadataField',
primaryKeyField: 'primaryKeyField',
textField: 'textField',
vectorField: 'vectorField',
// the properties below are optional
customMetadataField: 'customMetadataField',
},
resourceArn: 'resourceArn',
tableName: 'tableName',
},
s3VectorsConfiguration: {
indexArn: 'indexArn',
indexName: 'indexName',
vectorBucketArn: 'vectorBucketArn',
},
},
tags: {
tagsKey: 'tags',
},
});
python
# 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
# model_configuration: Any
cfn_knowledge_base = bedrock.CfnKnowledgeBase(self, "MyCfnKnowledgeBase",
knowledge_base_configuration=bedrock.CfnKnowledgeBase.KnowledgeBaseConfigurationProperty(
type="type",
# the properties below are optional
kendra_knowledge_base_configuration=bedrock.CfnKnowledgeBase.KendraKnowledgeBaseConfigurationProperty(
kendra_index_arn="kendraIndexArn"
),
managed_knowledge_base_configuration=bedrock.CfnKnowledgeBase.ManagedKnowledgeBaseConfigurationProperty(
embedding_model_arn="embeddingModelArn",
embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
audio=[bedrock.CfnKnowledgeBase.AudioConfigurationProperty(
segmentation_configuration=bedrock.CfnKnowledgeBase.AudioSegmentationConfigurationProperty(
fixed_length_duration=123
)
)],
dimensions=123,
embedding_data_type="embeddingDataType",
model_configuration=model_configuration,
video=[bedrock.CfnKnowledgeBase.VideoConfigurationProperty(
segmentation_configuration=bedrock.CfnKnowledgeBase.VideoSegmentationConfigurationProperty(
fixed_length_duration=123
)
)]
)
),
embedding_model_type="embeddingModelType",
server_side_encryption_configuration=bedrock.CfnKnowledgeBase.ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty(
kms_key_arn="kmsKeyArn"
),
supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty(
supplemental_data_storage_locations=[bedrock.CfnKnowledgeBase.SupplementalDataStorageLocationProperty(
supplemental_data_storage_location_type="supplementalDataStorageLocationType",
# the properties below are optional
s3_location=bedrock.CfnKnowledgeBase.S3LocationProperty(
uri="uri"
)
)]
)
),
sql_knowledge_base_configuration=bedrock.CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty(
type="type",
# the properties below are optional
redshift_configuration=bedrock.CfnKnowledgeBase.RedshiftConfigurationProperty(
query_engine_configuration=bedrock.CfnKnowledgeBase.RedshiftQueryEngineConfigurationProperty(
type="type",
# the properties below are optional
provisioned_configuration=bedrock.CfnKnowledgeBase.RedshiftProvisionedConfigurationProperty(
auth_configuration=bedrock.CfnKnowledgeBase.RedshiftProvisionedAuthConfigurationProperty(
type="type",
# the properties below are optional
database_user="databaseUser",
username_password_secret_arn="usernamePasswordSecretArn"
),
cluster_identifier="clusterIdentifier"
),
serverless_configuration=bedrock.CfnKnowledgeBase.RedshiftServerlessConfigurationProperty(
auth_configuration=bedrock.CfnKnowledgeBase.RedshiftServerlessAuthConfigurationProperty(
type="type",
# the properties below are optional
username_password_secret_arn="usernamePasswordSecretArn"
),
workgroup_arn="workgroupArn"
)
),
storage_configurations=[bedrock.CfnKnowledgeBase.RedshiftQueryEngineStorageConfigurationProperty(
type="type",
# the properties below are optional
aws_data_catalog_configuration=bedrock.CfnKnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty(
table_names=["tableNames"]
),
redshift_configuration=bedrock.CfnKnowledgeBase.RedshiftQueryEngineRedshiftStorageConfigurationProperty(
database_name="databaseName"
)
)],
# the properties below are optional
query_generation_configuration=bedrock.CfnKnowledgeBase.QueryGenerationConfigurationProperty(
execution_timeout_seconds=123,
generation_context=bedrock.CfnKnowledgeBase.QueryGenerationContextProperty(
curated_queries=[bedrock.CfnKnowledgeBase.CuratedQueryProperty(
natural_language="naturalLanguage",
sql="sql"
)],
tables=[bedrock.CfnKnowledgeBase.QueryGenerationTableProperty(
name="name",
# the properties below are optional
columns=[bedrock.CfnKnowledgeBase.QueryGenerationColumnProperty(
description="description",
inclusion="inclusion",
name="name"
)],
description="description",
inclusion="inclusion"
)]
)
)
)
),
vector_knowledge_base_configuration=bedrock.CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty(
embedding_model_arn="embeddingModelArn",
# the properties below are optional
embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty(
bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty(
audio=[bedrock.CfnKnowledgeBase.AudioConfigurationProperty(
segmentation_configuration=bedrock.CfnKnowledgeBase.AudioSegmentationConfigurationProperty(
fixed_length_duration=123
)
)],
dimensions=123,
embedding_data_type="embeddingDataType",
model_configuration=model_configuration,
video=[bedrock.CfnKnowledgeBase.VideoConfigurationProperty(
segmentation_configuration=bedrock.CfnKnowledgeBase.VideoSegmentationConfigurationProperty(
fixed_length_duration=123
)
)]
)
),
supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty(
supplemental_data_storage_locations=[bedrock.CfnKnowledgeBase.SupplementalDataStorageLocationProperty(
supplemental_data_storage_location_type="supplementalDataStorageLocationType",
# the properties below are optional
s3_location=bedrock.CfnKnowledgeBase.S3LocationProperty(
uri="uri"
)
)]
)
)
),
name="name",
role_arn="roleArn",
# the properties below are optional
description="description",
storage_configuration=bedrock.CfnKnowledgeBase.StorageConfigurationProperty(
type="type",
# the properties below are optional
mongo_db_atlas_configuration=bedrock.CfnKnowledgeBase.MongoDbAtlasConfigurationProperty(
collection_name="collectionName",
credentials_secret_arn="credentialsSecretArn",
database_name="databaseName",
endpoint="endpoint",
field_mapping=bedrock.CfnKnowledgeBase.MongoDbAtlasFieldMappingProperty(
metadata_field="metadataField",
text_field="textField",
vector_field="vectorField"
),
vector_index_name="vectorIndexName",
# the properties below are optional
endpoint_service_name="endpointServiceName",
text_index_name="textIndexName"
),
neptune_analytics_configuration=bedrock.CfnKnowledgeBase.NeptuneAnalyticsConfigurationProperty(
field_mapping=bedrock.CfnKnowledgeBase.NeptuneAnalyticsFieldMappingProperty(
metadata_field="metadataField",
text_field="textField"
),
graph_arn="graphArn"
),
opensearch_managed_cluster_configuration=bedrock.CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty(
domain_arn="domainArn",
domain_endpoint="domainEndpoint",
field_mapping=bedrock.CfnKnowledgeBase.OpenSearchManagedClusterFieldMappingProperty(
metadata_field="metadataField",
text_field="textField",
vector_field="vectorField"
),
vector_index_name="vectorIndexName"
),
opensearch_serverless_configuration=bedrock.CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty(
collection_arn="collectionArn",
field_mapping=bedrock.CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty(
metadata_field="metadataField",
text_field="textField",
vector_field="vectorField"
),
vector_index_name="vectorIndexName"
),
pinecone_configuration=bedrock.CfnKnowledgeBase.PineconeConfigurationProperty(
connection_string="connectionString",
credentials_secret_arn="credentialsSecretArn",
field_mapping=bedrock.CfnKnowledgeBase.PineconeFieldMappingProperty(
metadata_field="metadataField",
text_field="textField"
),
# the properties below are optional
namespace="namespace"
),
rds_configuration=bedrock.CfnKnowledgeBase.RdsConfigurationProperty(
credentials_secret_arn="credentialsSecretArn",
database_name="databaseName",
field_mapping=bedrock.CfnKnowledgeBase.RdsFieldMappingProperty(
metadata_field="metadataField",
primary_key_field="primaryKeyField",
text_field="textField",
vector_field="vectorField",
# the properties below are optional
custom_metadata_field="customMetadataField"
),
resource_arn="resourceArn",
table_name="tableName"
),
s3_vectors_configuration=bedrock.CfnKnowledgeBase.S3VectorsConfigurationProperty(
index_arn="indexArn",
index_name="indexName",
vector_bucket_arn="vectorBucketArn"
)
),
tags={
"tags_key": "tags"
}
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.*;
Object modelConfiguration;
CfnKnowledgeBase cfnKnowledgeBase = CfnKnowledgeBase.Builder.create(this, "MyCfnKnowledgeBase")
.knowledgeBaseConfiguration(KnowledgeBaseConfigurationProperty.builder()
.type("type")
// the properties below are optional
.kendraKnowledgeBaseConfiguration(KendraKnowledgeBaseConfigurationProperty.builder()
.kendraIndexArn("kendraIndexArn")
.build())
.managedKnowledgeBaseConfiguration(ManagedKnowledgeBaseConfigurationProperty.builder()
.embeddingModelArn("embeddingModelArn")
.embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
.bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
.audio(List.of(AudioConfigurationProperty.builder()
.segmentationConfiguration(AudioSegmentationConfigurationProperty.builder()
.fixedLengthDuration(123)
.build())
.build()))
.dimensions(123)
.embeddingDataType("embeddingDataType")
.modelConfiguration(modelConfiguration)
.video(List.of(VideoConfigurationProperty.builder()
.segmentationConfiguration(VideoSegmentationConfigurationProperty.builder()
.fixedLengthDuration(123)
.build())
.build()))
.build())
.build())
.embeddingModelType("embeddingModelType")
.serverSideEncryptionConfiguration(ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty.builder()
.kmsKeyArn("kmsKeyArn")
.build())
.supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
.supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
.supplementalDataStorageLocationType("supplementalDataStorageLocationType")
// the properties below are optional
.s3Location(S3LocationProperty.builder()
.uri("uri")
.build())
.build()))
.build())
.build())
.sqlKnowledgeBaseConfiguration(SqlKnowledgeBaseConfigurationProperty.builder()
.type("type")
// the properties below are optional
.redshiftConfiguration(RedshiftConfigurationProperty.builder()
.queryEngineConfiguration(RedshiftQueryEngineConfigurationProperty.builder()
.type("type")
// the properties below are optional
.provisionedConfiguration(RedshiftProvisionedConfigurationProperty.builder()
.authConfiguration(RedshiftProvisionedAuthConfigurationProperty.builder()
.type("type")
// the properties below are optional
.databaseUser("databaseUser")
.usernamePasswordSecretArn("usernamePasswordSecretArn")
.build())
.clusterIdentifier("clusterIdentifier")
.build())
.serverlessConfiguration(RedshiftServerlessConfigurationProperty.builder()
.authConfiguration(RedshiftServerlessAuthConfigurationProperty.builder()
.type("type")
// the properties below are optional
.usernamePasswordSecretArn("usernamePasswordSecretArn")
.build())
.workgroupArn("workgroupArn")
.build())
.build())
.storageConfigurations(List.of(RedshiftQueryEngineStorageConfigurationProperty.builder()
.type("type")
// the properties below are optional
.awsDataCatalogConfiguration(RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty.builder()
.tableNames(List.of("tableNames"))
.build())
.redshiftConfiguration(RedshiftQueryEngineRedshiftStorageConfigurationProperty.builder()
.databaseName("databaseName")
.build())
.build()))
// the properties below are optional
.queryGenerationConfiguration(QueryGenerationConfigurationProperty.builder()
.executionTimeoutSeconds(123)
.generationContext(QueryGenerationContextProperty.builder()
.curatedQueries(List.of(CuratedQueryProperty.builder()
.naturalLanguage("naturalLanguage")
.sql("sql")
.build()))
.tables(List.of(QueryGenerationTableProperty.builder()
.name("name")
// the properties below are optional
.columns(List.of(QueryGenerationColumnProperty.builder()
.description("description")
.inclusion("inclusion")
.name("name")
.build()))
.description("description")
.inclusion("inclusion")
.build()))
.build())
.build())
.build())
.build())
.vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
.embeddingModelArn("embeddingModelArn")
// the properties below are optional
.embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
.bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
.audio(List.of(AudioConfigurationProperty.builder()
.segmentationConfiguration(AudioSegmentationConfigurationProperty.builder()
.fixedLengthDuration(123)
.build())
.build()))
.dimensions(123)
.embeddingDataType("embeddingDataType")
.modelConfiguration(modelConfiguration)
.video(List.of(VideoConfigurationProperty.builder()
.segmentationConfiguration(VideoSegmentationConfigurationProperty.builder()
.fixedLengthDuration(123)
.build())
.build()))
.build())
.build())
.supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
.supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
.supplementalDataStorageLocationType("supplementalDataStorageLocationType")
// the properties below are optional
.s3Location(S3LocationProperty.builder()
.uri("uri")
.build())
.build()))
.build())
.build())
.build())
.name("name")
.roleArn("roleArn")
// the properties below are optional
.description("description")
.storageConfiguration(StorageConfigurationProperty.builder()
.type("type")
// the properties below are optional
.mongoDbAtlasConfiguration(MongoDbAtlasConfigurationProperty.builder()
.collectionName("collectionName")
.credentialsSecretArn("credentialsSecretArn")
.databaseName("databaseName")
.endpoint("endpoint")
.fieldMapping(MongoDbAtlasFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.vectorField("vectorField")
.build())
.vectorIndexName("vectorIndexName")
// the properties below are optional
.endpointServiceName("endpointServiceName")
.textIndexName("textIndexName")
.build())
.neptuneAnalyticsConfiguration(NeptuneAnalyticsConfigurationProperty.builder()
.fieldMapping(NeptuneAnalyticsFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.build())
.graphArn("graphArn")
.build())
.opensearchManagedClusterConfiguration(OpenSearchManagedClusterConfigurationProperty.builder()
.domainArn("domainArn")
.domainEndpoint("domainEndpoint")
.fieldMapping(OpenSearchManagedClusterFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.vectorField("vectorField")
.build())
.vectorIndexName("vectorIndexName")
.build())
.opensearchServerlessConfiguration(OpenSearchServerlessConfigurationProperty.builder()
.collectionArn("collectionArn")
.fieldMapping(OpenSearchServerlessFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.vectorField("vectorField")
.build())
.vectorIndexName("vectorIndexName")
.build())
.pineconeConfiguration(PineconeConfigurationProperty.builder()
.connectionString("connectionString")
.credentialsSecretArn("credentialsSecretArn")
.fieldMapping(PineconeFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.build())
// the properties below are optional
.namespace("namespace")
.build())
.rdsConfiguration(RdsConfigurationProperty.builder()
.credentialsSecretArn("credentialsSecretArn")
.databaseName("databaseName")
.fieldMapping(RdsFieldMappingProperty.builder()
.metadataField("metadataField")
.primaryKeyField("primaryKeyField")
.textField("textField")
.vectorField("vectorField")
// the properties below are optional
.customMetadataField("customMetadataField")
.build())
.resourceArn("resourceArn")
.tableName("tableName")
.build())
.s3VectorsConfiguration(S3VectorsConfigurationProperty.builder()
.indexArn("indexArn")
.indexName("indexName")
.vectorBucketArn("vectorBucketArn")
.build())
.build())
.tags(Map.of(
"tagsKey", "tags"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 modelConfiguration;
var cfnKnowledgeBase = new CfnKnowledgeBase(this, "MyCfnKnowledgeBase", new CfnKnowledgeBaseProps {
KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty {
Type = "type",
// the properties below are optional
KendraKnowledgeBaseConfiguration = new KendraKnowledgeBaseConfigurationProperty {
KendraIndexArn = "kendraIndexArn"
},
ManagedKnowledgeBaseConfiguration = new ManagedKnowledgeBaseConfigurationProperty {
EmbeddingModelArn = "embeddingModelArn",
EmbeddingModelConfiguration = new EmbeddingModelConfigurationProperty {
BedrockEmbeddingModelConfiguration = new BedrockEmbeddingModelConfigurationProperty {
Audio = new [] { new AudioConfigurationProperty {
SegmentationConfiguration = new AudioSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} },
Dimensions = 123,
EmbeddingDataType = "embeddingDataType",
ModelConfiguration = modelConfiguration,
Video = new [] { new VideoConfigurationProperty {
SegmentationConfiguration = new VideoSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} }
}
},
EmbeddingModelType = "embeddingModelType",
ServerSideEncryptionConfiguration = new ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty {
KmsKeyArn = "kmsKeyArn"
},
SupplementalDataStorageConfiguration = new SupplementalDataStorageConfigurationProperty {
SupplementalDataStorageLocations = new [] { new SupplementalDataStorageLocationProperty {
SupplementalDataStorageLocationType = "supplementalDataStorageLocationType",
// the properties below are optional
S3Location = new S3LocationProperty {
Uri = "uri"
}
} }
}
},
SqlKnowledgeBaseConfiguration = new SqlKnowledgeBaseConfigurationProperty {
Type = "type",
// the properties below are optional
RedshiftConfiguration = new RedshiftConfigurationProperty {
QueryEngineConfiguration = new RedshiftQueryEngineConfigurationProperty {
Type = "type",
// the properties below are optional
ProvisionedConfiguration = new RedshiftProvisionedConfigurationProperty {
AuthConfiguration = new RedshiftProvisionedAuthConfigurationProperty {
Type = "type",
// the properties below are optional
DatabaseUser = "databaseUser",
UsernamePasswordSecretArn = "usernamePasswordSecretArn"
},
ClusterIdentifier = "clusterIdentifier"
},
ServerlessConfiguration = new RedshiftServerlessConfigurationProperty {
AuthConfiguration = new RedshiftServerlessAuthConfigurationProperty {
Type = "type",
// the properties below are optional
UsernamePasswordSecretArn = "usernamePasswordSecretArn"
},
WorkgroupArn = "workgroupArn"
}
},
StorageConfigurations = new [] { new RedshiftQueryEngineStorageConfigurationProperty {
Type = "type",
// the properties below are optional
AwsDataCatalogConfiguration = new RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty {
TableNames = new [] { "tableNames" }
},
RedshiftConfiguration = new RedshiftQueryEngineRedshiftStorageConfigurationProperty {
DatabaseName = "databaseName"
}
} },
// the properties below are optional
QueryGenerationConfiguration = new QueryGenerationConfigurationProperty {
ExecutionTimeoutSeconds = 123,
GenerationContext = new QueryGenerationContextProperty {
CuratedQueries = new [] { new CuratedQueryProperty {
NaturalLanguage = "naturalLanguage",
Sql = "sql"
} },
Tables = new [] { new QueryGenerationTableProperty {
Name = "name",
// the properties below are optional
Columns = new [] { new QueryGenerationColumnProperty {
Description = "description",
Inclusion = "inclusion",
Name = "name"
} },
Description = "description",
Inclusion = "inclusion"
} }
}
}
}
},
VectorKnowledgeBaseConfiguration = new VectorKnowledgeBaseConfigurationProperty {
EmbeddingModelArn = "embeddingModelArn",
// the properties below are optional
EmbeddingModelConfiguration = new EmbeddingModelConfigurationProperty {
BedrockEmbeddingModelConfiguration = new BedrockEmbeddingModelConfigurationProperty {
Audio = new [] { new AudioConfigurationProperty {
SegmentationConfiguration = new AudioSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} },
Dimensions = 123,
EmbeddingDataType = "embeddingDataType",
ModelConfiguration = modelConfiguration,
Video = new [] { new VideoConfigurationProperty {
SegmentationConfiguration = new VideoSegmentationConfigurationProperty {
FixedLengthDuration = 123
}
} }
}
},
SupplementalDataStorageConfiguration = new SupplementalDataStorageConfigurationProperty {
SupplementalDataStorageLocations = new [] { new SupplementalDataStorageLocationProperty {
SupplementalDataStorageLocationType = "supplementalDataStorageLocationType",
// the properties below are optional
S3Location = new S3LocationProperty {
Uri = "uri"
}
} }
}
}
},
Name = "name",
RoleArn = "roleArn",
// the properties below are optional
Description = "description",
StorageConfiguration = new StorageConfigurationProperty {
Type = "type",
// the properties below are optional
MongoDbAtlasConfiguration = new MongoDbAtlasConfigurationProperty {
CollectionName = "collectionName",
CredentialsSecretArn = "credentialsSecretArn",
DatabaseName = "databaseName",
Endpoint = "endpoint",
FieldMapping = new MongoDbAtlasFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName",
// the properties below are optional
EndpointServiceName = "endpointServiceName",
TextIndexName = "textIndexName"
},
NeptuneAnalyticsConfiguration = new NeptuneAnalyticsConfigurationProperty {
FieldMapping = new NeptuneAnalyticsFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField"
},
GraphArn = "graphArn"
},
OpensearchManagedClusterConfiguration = new OpenSearchManagedClusterConfigurationProperty {
DomainArn = "domainArn",
DomainEndpoint = "domainEndpoint",
FieldMapping = new OpenSearchManagedClusterFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName"
},
OpensearchServerlessConfiguration = new OpenSearchServerlessConfigurationProperty {
CollectionArn = "collectionArn",
FieldMapping = new OpenSearchServerlessFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField",
VectorField = "vectorField"
},
VectorIndexName = "vectorIndexName"
},
PineconeConfiguration = new PineconeConfigurationProperty {
ConnectionString = "connectionString",
CredentialsSecretArn = "credentialsSecretArn",
FieldMapping = new PineconeFieldMappingProperty {
MetadataField = "metadataField",
TextField = "textField"
},
// the properties below are optional
Namespace = "namespace"
},
RdsConfiguration = new RdsConfigurationProperty {
CredentialsSecretArn = "credentialsSecretArn",
DatabaseName = "databaseName",
FieldMapping = new RdsFieldMappingProperty {
MetadataField = "metadataField",
PrimaryKeyField = "primaryKeyField",
TextField = "textField",
VectorField = "vectorField",
// the properties below are optional
CustomMetadataField = "customMetadataField"
},
ResourceArn = "resourceArn",
TableName = "tableName"
},
S3VectorsConfiguration = new S3VectorsConfigurationProperty {
IndexArn = "indexArn",
IndexName = "indexName",
VectorBucketArn = "vectorBucketArn"
}
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var modelConfiguration interface{}
cfnKnowledgeBase := awscdk.Aws_bedrock.NewCfnKnowledgeBase(this, jsii.String("MyCfnKnowledgeBase"), &CfnKnowledgeBaseProps{
KnowledgeBaseConfiguration: &KnowledgeBaseConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
KendraKnowledgeBaseConfiguration: &KendraKnowledgeBaseConfigurationProperty{
KendraIndexArn: jsii.String("kendraIndexArn"),
},
ManagedKnowledgeBaseConfiguration: &ManagedKnowledgeBaseConfigurationProperty{
EmbeddingModelArn: jsii.String("embeddingModelArn"),
EmbeddingModelConfiguration: &EmbeddingModelConfigurationProperty{
BedrockEmbeddingModelConfiguration: &BedrockEmbeddingModelConfigurationProperty{
Audio: []interface{}{
&AudioConfigurationProperty{
SegmentationConfiguration: &AudioSegmentationConfigurationProperty{
FixedLengthDuration: jsii.Number(123),
},
},
},
Dimensions: jsii.Number(123),
EmbeddingDataType: jsii.String("embeddingDataType"),
ModelConfiguration: modelConfiguration,
Video: []interface{}{
&VideoConfigurationProperty{
SegmentationConfiguration: &VideoSegmentationConfigurationProperty{
FixedLengthDuration: jsii.Number(123),
},
},
},
},
},
EmbeddingModelType: jsii.String("embeddingModelType"),
ServerSideEncryptionConfiguration: &ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty{
KmsKeyArn: jsii.String("kmsKeyArn"),
},
SupplementalDataStorageConfiguration: &SupplementalDataStorageConfigurationProperty{
SupplementalDataStorageLocations: []interface{}{
&SupplementalDataStorageLocationProperty{
SupplementalDataStorageLocationType: jsii.String("supplementalDataStorageLocationType"),
// the properties below are optional
S3Location: &S3LocationProperty{
Uri: jsii.String("uri"),
},
},
},
},
},
SqlKnowledgeBaseConfiguration: &SqlKnowledgeBaseConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
RedshiftConfiguration: &RedshiftConfigurationProperty{
QueryEngineConfiguration: &RedshiftQueryEngineConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
ProvisionedConfiguration: &RedshiftProvisionedConfigurationProperty{
AuthConfiguration: &RedshiftProvisionedAuthConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
DatabaseUser: jsii.String("databaseUser"),
UsernamePasswordSecretArn: jsii.String("usernamePasswordSecretArn"),
},
ClusterIdentifier: jsii.String("clusterIdentifier"),
},
ServerlessConfiguration: &RedshiftServerlessConfigurationProperty{
AuthConfiguration: &RedshiftServerlessAuthConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
UsernamePasswordSecretArn: jsii.String("usernamePasswordSecretArn"),
},
WorkgroupArn: jsii.String("workgroupArn"),
},
},
StorageConfigurations: []interface{}{
&RedshiftQueryEngineStorageConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
AwsDataCatalogConfiguration: &RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty{
TableNames: []*string{
jsii.String("tableNames"),
},
},
RedshiftConfiguration: &RedshiftQueryEngineRedshiftStorageConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
},
},
},
// the properties below are optional
QueryGenerationConfiguration: &QueryGenerationConfigurationProperty{
ExecutionTimeoutSeconds: jsii.Number(123),
GenerationContext: &QueryGenerationContextProperty{
CuratedQueries: []interface{}{
&CuratedQueryProperty{
NaturalLanguage: jsii.String("naturalLanguage"),
Sql: jsii.String("sql"),
},
},
Tables: []interface{}{
&QueryGenerationTableProperty{
Name: jsii.String("name"),
// the properties below are optional
Columns: []interface{}{
&QueryGenerationColumnProperty{
Description: jsii.String("description"),
Inclusion: jsii.String("inclusion"),
Name: jsii.String("name"),
},
},
Description: jsii.String("description"),
Inclusion: jsii.String("inclusion"),
},
},
},
},
},
},
VectorKnowledgeBaseConfiguration: &VectorKnowledgeBaseConfigurationProperty{
EmbeddingModelArn: jsii.String("embeddingModelArn"),
// the properties below are optional
EmbeddingModelConfiguration: &EmbeddingModelConfigurationProperty{
BedrockEmbeddingModelConfiguration: &BedrockEmbeddingModelConfigurationProperty{
Audio: []interface{}{
&AudioConfigurationProperty{
SegmentationConfiguration: &AudioSegmentationConfigurationProperty{
FixedLengthDuration: jsii.Number(123),
},
},
},
Dimensions: jsii.Number(123),
EmbeddingDataType: jsii.String("embeddingDataType"),
ModelConfiguration: modelConfiguration,
Video: []interface{}{
&VideoConfigurationProperty{
SegmentationConfiguration: &VideoSegmentationConfigurationProperty{
FixedLengthDuration: jsii.Number(123),
},
},
},
},
},
SupplementalDataStorageConfiguration: &SupplementalDataStorageConfigurationProperty{
SupplementalDataStorageLocations: []interface{}{
&SupplementalDataStorageLocationProperty{
SupplementalDataStorageLocationType: jsii.String("supplementalDataStorageLocationType"),
// the properties below are optional
S3Location: &S3LocationProperty{
Uri: jsii.String("uri"),
},
},
},
},
},
},
Name: jsii.String("name"),
RoleArn: jsii.String("roleArn"),
// the properties below are optional
Description: jsii.String("description"),
StorageConfiguration: &StorageConfigurationProperty{
Type: jsii.String("type"),
// the properties below are optional
MongoDbAtlasConfiguration: &MongoDbAtlasConfigurationProperty{
CollectionName: jsii.String("collectionName"),
CredentialsSecretArn: jsii.String("credentialsSecretArn"),
DatabaseName: jsii.String("databaseName"),
Endpoint: jsii.String("endpoint"),
FieldMapping: &MongoDbAtlasFieldMappingProperty{
MetadataField: jsii.String("metadataField"),
TextField: jsii.String("textField"),
VectorField: jsii.String("vectorField"),
},
VectorIndexName: jsii.String("vectorIndexName"),
// the properties below are optional
EndpointServiceName: jsii.String("endpointServiceName"),
TextIndexName: jsii.String("textIndexName"),
},
NeptuneAnalyticsConfiguration: &NeptuneAnalyticsConfigurationProperty{
FieldMapping: &NeptuneAnalyticsFieldMappingProperty{
MetadataField: jsii.String("metadataField"),
TextField: jsii.String("textField"),
},
GraphArn: jsii.String("graphArn"),
},
OpensearchManagedClusterConfiguration: &OpenSearchManagedClusterConfigurationProperty{
DomainArn: jsii.String("domainArn"),
DomainEndpoint: jsii.String("domainEndpoint"),
FieldMapping: &OpenSearchManagedClusterFieldMappingProperty{
MetadataField: jsii.String("metadataField"),
TextField: jsii.String("textField"),
VectorField: jsii.String("vectorField"),
},
VectorIndexName: jsii.String("vectorIndexName"),
},
OpensearchServerlessConfiguration: &OpenSearchServerlessConfigurationProperty{
CollectionArn: jsii.String("collectionArn"),
FieldMapping: &OpenSearchServerlessFieldMappingProperty{
MetadataField: jsii.String("metadataField"),
TextField: jsii.String("textField"),
VectorField: jsii.String("vectorField"),
},
VectorIndexName: jsii.String("vectorIndexName"),
},
PineconeConfiguration: &PineconeConfigurationProperty{
ConnectionString: jsii.String("connectionString"),
CredentialsSecretArn: jsii.String("credentialsSecretArn"),
FieldMapping: &PineconeFieldMappingProperty{
MetadataField: jsii.String("metadataField"),
TextField: jsii.String("textField"),
},
// the properties below are optional
Namespace: jsii.String("namespace"),
},
RdsConfiguration: &RdsConfigurationProperty{
CredentialsSecretArn: jsii.String("credentialsSecretArn"),
DatabaseName: jsii.String("databaseName"),
FieldMapping: &RdsFieldMappingProperty{
MetadataField: jsii.String("metadataField"),
PrimaryKeyField: jsii.String("primaryKeyField"),
TextField: jsii.String("textField"),
VectorField: jsii.String("vectorField"),
// the properties below are optional
CustomMetadataField: jsii.String("customMetadataField"),
},
ResourceArn: jsii.String("resourceArn"),
TableName: jsii.String("tableName"),
},
S3VectorsConfiguration: &S3VectorsConfigurationProperty{
IndexArn: jsii.String("indexArn"),
IndexName: jsii.String("indexName"),
VectorBucketArn: jsii.String("vectorBucketArn"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
Initializer
ts
new CfnKnowledgeBase(scope: Construct, id: string, props: CfnKnowledgeBaseProps)
python
CfnKnowledgeBase(scope: Construct, id: str, props: CfnKnowledgeBaseProps)
java
new CfnKnowledgeBase(Construct scope, String id, CfnKnowledgeBaseProps props)
csharp
new CfnKnowledgeBase(Construct scope, string id, CfnKnowledgeBaseProps props)
go
NewCfnKnowledgeBase(Scope Construct, Id *string, Props CfnKnowledgeBaseProps)
Construct Props
The description of the knowledge base associated with the inline agent.
knowledgeBaseConfigurationIResolvable | CfnKnowledgeBase.KnowledgeBaseConfigurationPropertyknowledge_base_configurationtyping.Union[IResolvable, KnowledgeBaseConfigurationProperty]knowledgeBaseConfigurationIResolvableKnowledgeBaseConfigurationIResolvableKnowledgeBaseConfigurationinterface{}required#Contains details about the embeddings configuration of the knowledge base.
The name of the knowledge base.
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
storageConfigurationIResolvable | CfnKnowledgeBase.StorageConfigurationPropertystorage_configurationtyping.Union[IResolvable, StorageConfigurationProperty]storageConfigurationIResolvableStorageConfigurationIResolvableStorageConfigurationinterface{}#Contains details about the storage configuration of the knowledge base.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
Properties
attrCreatedAtstringattr_created_atstrattrCreatedAtStringAttrCreatedAtstringAttrCreatedAt*stringrequired#The time the knowledge base was created.
attrFailureReasonsstring[]attr_failure_reasonstyping.List[str]attrFailureReasonsList<String>AttrFailureReasonsstring[]AttrFailureReasons*[]*stringrequired#A list of reasons that the API operation on the knowledge base failed.
attrKnowledgeBaseArnstringattr_knowledge_base_arnstrattrKnowledgeBaseArnStringAttrKnowledgeBaseArnstringAttrKnowledgeBaseArn*stringrequired#The Amazon Resource Name (ARN) of the knowledge base.
attrKnowledgeBaseIdstringattr_knowledge_base_idstrattrKnowledgeBaseIdStringAttrKnowledgeBaseIdstringAttrKnowledgeBaseId*stringrequired#The unique identifier for a knowledge base associated with the inline agent.
The status of the knowledge base.
attrUpdatedAtstringattr_updated_atstrattrUpdatedAtStringAttrUpdatedAtstringAttrUpdatedAt*stringrequired#The time the knowledge base was last updated.
cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManagerrequired#Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#The description of the knowledge base associated with the inline agent.
knowledgeBaseConfigurationIResolvable | CfnKnowledgeBase.KnowledgeBaseConfigurationPropertyknowledge_base_configurationtyping.Union[IResolvable, KnowledgeBaseConfigurationProperty]knowledgeBaseConfigurationIResolvableKnowledgeBaseConfigurationIResolvableKnowledgeBaseConfigurationinterface{}required#Contains details about the embeddings configuration of the knowledge base.
knowledgeBaseRefKnowledgeBaseReferenceknowledge_base_refKnowledgeBaseReferenceknowledgeBaseRefKnowledgeBaseReferenceKnowledgeBaseRefKnowledgeBaseReferenceKnowledgeBaseRefKnowledgeBaseReferencerequired#A reference to a KnowledgeBase resource.
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).
The name of the knowledge base.
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 }).
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
storageConfigurationIResolvable | CfnKnowledgeBase.StorageConfigurationPropertystorage_configurationtyping.Union[IResolvable, StorageConfigurationProperty]storageConfigurationIResolvableStorageConfigurationIResolvableStorageConfigurationinterface{}#Contains details about the storage configuration of the knowledge base.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#Metadata that you can assign to a resource as key-value pairs.
For more information, see the following resources:.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
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,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"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
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
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:
arnForKnowledgeBase(resource: IKnowledgeBaseRef): string@staticmethod def arn_for_knowledge_base(resource: IKnowledgeBaseRef) -> strpublic static String arnForKnowledgeBase(IKnowledgeBaseRef resource)public static string ArnForKnowledgeBase(IKnowledgeBaseRef resource)func ArnForKnowledgeBase(Resource IKnowledgeBaseRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromKnowledgeBaseArn(scope: Construct, id: string, arn: string): IKnowledgeBaseRef@staticmethod def from_knowledge_base_arn(scope: Construct, id: str, arn: str) -> IKnowledgeBaseRefpublic static IKnowledgeBaseRef fromKnowledgeBaseArn(Construct scope, String id, String arn)public static IKnowledgeBaseRef FromKnowledgeBaseArn(Construct scope, string id, string arn)func FromKnowledgeBaseArn(Scope Construct, Id *string, Arn *string) IKnowledgeBaseRefstatic#Creates a new IKnowledgeBaseRef from an ARN.
fromKnowledgeBaseId(scope: Construct, id: string, knowledgeBaseId: string): IKnowledgeBaseRef@staticmethod def from_knowledge_base_id(scope: Construct, id: str, knowledge_base_id: str) -> IKnowledgeBaseRefpublic static IKnowledgeBaseRef fromKnowledgeBaseId(Construct scope, String id, String knowledgeBaseId)public static IKnowledgeBaseRef FromKnowledgeBaseId(Construct scope, string id, string knowledgeBaseId)func FromKnowledgeBaseId(Scope Construct, Id *string, KnowledgeBaseId *string) IKnowledgeBaseRefstatic#Creates a new IKnowledgeBaseRef from a knowledgeBaseId.
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#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.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#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.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnKnowledgeBase(x: any): boolean@staticmethod def is_cfn_knowledge_base(x: Any) -> boolpublic static Boolean isCfnKnowledgeBase(Object x)public static bool IsCfnKnowledgeBase(object x)func IsCfnKnowledgeBase(X interface{}) *boolstatic#Checks whether the given object is a CfnKnowledgeBase.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#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.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.