We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::Bedrock::RetrievalInstruction
Create RetrievalInstruction Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RetrievalInstruction(name: string, args: RetrievalInstructionArgs, opts?: CustomResourceOptions);@overload
def RetrievalInstruction(resource_name: str,
args: RetrievalInstructionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RetrievalInstruction(resource_name: str,
opts: Optional[ResourceOptions] = None,
instruction: Optional[RetrievalInstructionInstructionArgs] = None,
customer_encryption_key_arn: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewRetrievalInstruction(ctx *Context, name string, args RetrievalInstructionArgs, opts ...ResourceOption) (*RetrievalInstruction, error)public RetrievalInstruction(string name, RetrievalInstructionArgs args, CustomResourceOptions? opts = null)
public RetrievalInstruction(String name, RetrievalInstructionArgs args)
public RetrievalInstruction(String name, RetrievalInstructionArgs args, CustomResourceOptions options)
type: aws-native:bedrock:RetrievalInstruction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_bedrock_retrieval_instruction" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args RetrievalInstructionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RetrievalInstructionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RetrievalInstructionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RetrievalInstructionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RetrievalInstructionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
RetrievalInstruction Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RetrievalInstruction resource accepts the following input properties:
- Instruction
Pulumi.
Aws Native. Bedrock. Inputs. Retrieval Instruction Instruction - 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.
- Customer
Encryption stringKey Arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- Description string
- A description of the retrieval instruction. On a numbered version, the description of that version.
- Name string
- The name of the retrieval instruction.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Instruction
Retrieval
Instruction Instruction Args - 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.
- Customer
Encryption stringKey Arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- Description string
- A description of the retrieval instruction. On a numbered version, the description of that version.
- Name string
- The name of the retrieval instruction.
-
Tag
Args - An array of key-value pairs to apply to this resource.
- instruction object
- 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.
- customer_
encryption_ stringkey_ arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- description string
- A description of the retrieval instruction. On a numbered version, the description of that version.
- name string
- The name of the retrieval instruction.
- list(object)
- An array of key-value pairs to apply to this resource.
- instruction
Retrieval
Instruction Instruction - 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.
- customer
Encryption StringKey Arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- description String
- A description of the retrieval instruction. On a numbered version, the description of that version.
- name String
- The name of the retrieval instruction.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- instruction
Retrieval
Instruction Instruction - 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.
- customer
Encryption stringKey Arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- description string
- A description of the retrieval instruction. On a numbered version, the description of that version.
- name string
- The name of the retrieval instruction.
- Tag[]
- An array of key-value pairs to apply to this resource.
- instruction
Retrieval
Instruction Instruction Args - 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.
- customer_
encryption_ strkey_ arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- description str
- A description of the retrieval instruction. On a numbered version, the description of that version.
- name str
- The name of the retrieval instruction.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- instruction Property Map
- 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.
- customer
Encryption StringKey Arn - The ARN of the customer managed KMS key protecting this content, when one was supplied at create.
- description String
- A description of the retrieval instruction. On a numbered version, the description of that version.
- name String
- The name of the retrieval instruction.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the RetrievalInstruction resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the resource.
- Created
At string - When the retrieval instruction was created. On a numbered version, when that version was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Transition Pulumi.Status Aws Native. Bedrock. Retrieval Instruction Last Transition Status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- Retrieval
Instruction stringId - The identifier of the retrieval instruction.
- Status
Pulumi.
Aws Native. Bedrock. Retrieval Instruction Status - Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- Updated
At string - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
- Arn string
- The Amazon Resource Name (ARN) of the resource.
- Created
At string - When the retrieval instruction was created. On a numbered version, when that version was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Transition RetrievalStatus Instruction Last Transition Status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- Retrieval
Instruction stringId - The identifier of the retrieval instruction.
- Status
Retrieval
Instruction Status - Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- Updated
At string - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
- arn string
- The Amazon Resource Name (ARN) of the resource.
- created_
at string - When the retrieval instruction was created. On a numbered version, when that version was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last_
transition_ "CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED"status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- retrieval_
instruction_ stringid - The identifier of the retrieval instruction.
- status "ACTIVE" | "INACTIVE"
- Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- updated_
at string - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
- arn String
- The Amazon Resource Name (ARN) of the resource.
- created
At String - When the retrieval instruction was created. On a numbered version, when that version was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Transition RetrievalStatus Instruction Last Transition Status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- retrieval
Instruction StringId - The identifier of the retrieval instruction.
- status
Retrieval
Instruction Status - Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- updated
At String - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
- arn string
- The Amazon Resource Name (ARN) of the resource.
- created
At string - When the retrieval instruction was created. On a numbered version, when that version was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Transition RetrievalStatus Instruction Last Transition Status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- retrieval
Instruction stringId - The identifier of the retrieval instruction.
- status
Retrieval
Instruction Status - Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- updated
At string - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
- arn str
- The Amazon Resource Name (ARN) of the resource.
- created_
at str - When the retrieval instruction was created. On a numbered version, when that version was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
transition_ Retrievalstatus Instruction Last Transition Status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- retrieval_
instruction_ strid - The identifier of the retrieval instruction.
- status
Retrieval
Instruction Status - Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- updated_
at str - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
- arn String
- The Amazon Resource Name (ARN) of the resource.
- created
At String - When the retrieval instruction was created. On a numbered version, when that version was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Transition "CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED"Status - The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
- retrieval
Instruction StringId - The identifier of the retrieval instruction.
- status "ACTIVE" | "INACTIVE"
- Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
- updated
At String - When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.
Look up Existing RetrievalInstruction Resource
Get an existing RetrievalInstruction resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): RetrievalInstruction@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> RetrievalInstructionfunc GetRetrievalInstruction(ctx *Context, name string, id IDInput, state *RetrievalInstructionState, opts ...ResourceOption) (*RetrievalInstruction, error)public static RetrievalInstruction Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static RetrievalInstruction get(String name, Output<String> id, CustomResourceOptions options)resources: existingRetrievalInstruction: type: aws-native:bedrock:RetrievalInstruction get: id: ${id}import {
to = aws-native_bedrock_retrieval_instruction.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state RetrievalInstructionState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
RetrievalInstructionInstruction, RetrievalInstructionInstructionArgs
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.
- Answer
Format string - How the answer is structured, including how sources are cited.
- Answer
Policy string - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- Persona string
- Who the assistant is: identity, tone and language.
- Retrieval
Guidance string - How to interpret and decompose the question, and what to prioritise when searching.
- Answer
Format string - How the answer is structured, including how sources are cited.
- Answer
Policy string - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- Persona string
- Who the assistant is: identity, tone and language.
- Retrieval
Guidance string - How to interpret and decompose the question, and what to prioritise when searching.
- answer_
format string - How the answer is structured, including how sources are cited.
- answer_
policy string - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- persona string
- Who the assistant is: identity, tone and language.
- retrieval_
guidance string - How to interpret and decompose the question, and what to prioritise when searching.
- answer
Format String - How the answer is structured, including how sources are cited.
- answer
Policy String - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- persona String
- Who the assistant is: identity, tone and language.
- retrieval
Guidance String - How to interpret and decompose the question, and what to prioritise when searching.
- answer
Format string - How the answer is structured, including how sources are cited.
- answer
Policy string - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- persona string
- Who the assistant is: identity, tone and language.
- retrieval
Guidance string - How to interpret and decompose the question, and what to prioritise when searching.
- answer_
format str - How the answer is structured, including how sources are cited.
- answer_
policy str - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- persona str
- Who the assistant is: identity, tone and language.
- retrieval_
guidance str - How to interpret and decompose the question, and what to prioritise when searching.
- answer
Format String - How the answer is structured, including how sources are cited.
- answer
Policy String - Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.
- persona String
- Who the assistant is: identity, tone and language.
- retrieval
Guidance String - How to interpret and decompose the question, and what to prioritise when searching.
RetrievalInstructionLastTransitionStatus
The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.
| Name | Value |
|---|---|
| Creating | CREATING |
| Updating | UPDATING |
| Create | CREATE_SUCCESSFUL |
| Create | CREATE_FAILED |
| Update | UPDATE_SUCCESSFUL |
| Update | UPDATE_FAILED |
| Name | Value |
|---|---|
| Retrieval | CREATING |
| Retrieval | UPDATING |
| Retrieval | CREATE_SUCCESSFUL |
| Retrieval | CREATE_FAILED |
| Retrieval | UPDATE_SUCCESSFUL |
| Retrieval | UPDATE_FAILED |
| Value |
|---|
CREATING |
UPDATING |
CREATE_SUCCESSFUL |
CREATE_FAILED |
UPDATE_SUCCESSFUL |
UPDATE_FAILED |
| Name | Value |
|---|---|
| Creating | CREATING |
| Updating | UPDATING |
| Create | CREATE_SUCCESSFUL |
| Create | CREATE_FAILED |
| Update | UPDATE_SUCCESSFUL |
| Update | UPDATE_FAILED |
| Name | Value |
|---|---|
| Creating | CREATING |
| Updating | UPDATING |
| Create | CREATE_SUCCESSFUL |
| Create | CREATE_FAILED |
| Update | UPDATE_SUCCESSFUL |
| Update | UPDATE_FAILED |
| Name | Value |
|---|---|
| CREATING | CREATING |
| UPDATING | UPDATING |
| CREATE_SUCCESSFUL | CREATE_SUCCESSFUL |
| CREATE_FAILED | CREATE_FAILED |
| UPDATE_SUCCESSFUL | UPDATE_SUCCESSFUL |
| UPDATE_FAILED | UPDATE_FAILED |
| Value |
|---|
CREATING |
UPDATING |
CREATE_SUCCESSFUL |
CREATE_FAILED |
UPDATE_SUCCESSFUL |
UPDATE_FAILED |
RetrievalInstructionStatus
Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.
| Name | Value |
|---|---|
| Active | ACTIVE |
| Inactive | INACTIVE |
| Name | Value |
|---|---|
| Retrieval | ACTIVE |
| Retrieval | INACTIVE |
| Value |
|---|
ACTIVE |
INACTIVE |
| Name | Value |
|---|---|
| Active | ACTIVE |
| Inactive | INACTIVE |
| Name | Value |
|---|---|
| Active | ACTIVE |
| Inactive | INACTIVE |
| Name | Value |
|---|---|
| ACTIVE | ACTIVE |
| INACTIVE | INACTIVE |
| Value |
|---|
ACTIVE |
INACTIVE |
Tag, TagArgs
A set of tags to apply to the resource.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi