CfnRetrievalInstructionProps Struct
Properties for defining a CfnRetrievalInstruction.
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';
const cfnRetrievalInstructionProps: bedrock.CfnRetrievalInstructionProps = {
instruction: {
answerFormat: 'answerFormat',
answerPolicy: 'answerPolicy',
persona: 'persona',
retrievalGuidance: 'retrievalGuidance',
},
name: 'name',
// the properties below are optional
customerEncryptionKeyArn: 'customerEncryptionKeyArn',
description: 'description',
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# 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_retrieval_instruction_props = bedrock.CfnRetrievalInstructionProps(
instruction=bedrock.CfnRetrievalInstruction.InstructionProperty(
answer_format="answerFormat",
answer_policy="answerPolicy",
persona="persona",
retrieval_guidance="retrievalGuidance"
),
name="name",
# the properties below are optional
customer_encryption_key_arn="customerEncryptionKeyArn",
description="description",
tags=[CfnTag(
key="key",
value="value"
)]
)
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.*;
CfnRetrievalInstructionProps cfnRetrievalInstructionProps = CfnRetrievalInstructionProps.builder()
.instruction(InstructionProperty.builder()
.answerFormat("answerFormat")
.answerPolicy("answerPolicy")
.persona("persona")
.retrievalGuidance("retrievalGuidance")
.build())
.name("name")
// the properties below are optional
.customerEncryptionKeyArn("customerEncryptionKeyArn")
.description("description")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.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 cfnRetrievalInstructionProps = new CfnRetrievalInstructionProps {
Instruction = new InstructionProperty {
AnswerFormat = "answerFormat",
AnswerPolicy = "answerPolicy",
Persona = "persona",
RetrievalGuidance = "retrievalGuidance"
},
Name = "name",
// the properties below are optional
CustomerEncryptionKeyArn = "customerEncryptionKeyArn",
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
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"
cfnRetrievalInstructionProps := &CfnRetrievalInstructionProps{
Instruction: &InstructionProperty{
AnswerFormat: jsii.String("answerFormat"),
AnswerPolicy: jsii.String("answerPolicy"),
Persona: jsii.String("persona"),
RetrievalGuidance: jsii.String("retrievalGuidance"),
},
Name: jsii.String("name"),
// the properties below are optional
CustomerEncryptionKeyArn: jsii.String("customerEncryptionKeyArn"),
Description: jsii.String("description"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
customerEncryptionKeyArnoptionalstringcustomer_encryption_key_arnoptionalstrcustomerEncryptionKeyArnoptionalStringCustomerEncryptionKeyArnoptionalstringCustomerEncryptionKeyArnoptional*string#The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description of the retrieval instruction.
On a numbered version, the description of that version.
instructionIResolvable | CfnRetrievalInstruction.InstructionPropertyinstructiontyping.Union[IResolvable, InstructionProperty]instructionIResolvableInstructionIResolvableInstructioninterface{}required#The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE.
Absent until the first create review passes. Always present on a numbered version.
The name of the retrieval instruction.