1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. bedrock
  6. RetrievalInstruction

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
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.AwsNative.Bedrock.Inputs.RetrievalInstructionInstruction
    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.
    CustomerEncryptionKeyArn string
    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Instruction 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.
    CustomerEncryptionKeyArn string
    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.
    Tags TagArgs
    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_key_arn string
    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.
    tags list(object)
    An array of key-value pairs to apply to this resource.
    instruction RetrievalInstructionInstruction
    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.
    customerEncryptionKeyArn String
    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.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    instruction RetrievalInstructionInstruction
    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.
    customerEncryptionKeyArn string
    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.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    instruction 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.
    customer_encryption_key_arn str
    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.
    tags Sequence[TagArgs]
    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.
    customerEncryptionKeyArn String
    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.
    tags 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.
    CreatedAt 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.
    LastTransitionStatus Pulumi.AwsNative.Bedrock.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.
    RetrievalInstructionId string
    The identifier of the retrieval instruction.
    Status Pulumi.AwsNative.Bedrock.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.
    UpdatedAt 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.
    CreatedAt 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.
    LastTransitionStatus 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.
    RetrievalInstructionId string
    The identifier of the retrieval instruction.
    Status 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.
    UpdatedAt 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_status "CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED"
    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_id string
    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.
    createdAt 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.
    lastTransitionStatus 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.
    retrievalInstructionId String
    The identifier of the retrieval instruction.
    status 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.
    updatedAt 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.
    createdAt 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.
    lastTransitionStatus 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.
    retrievalInstructionId string
    The identifier of the retrieval instruction.
    status 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.
    updatedAt 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_status 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.
    retrieval_instruction_id str
    The identifier of the retrieval instruction.
    status 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.
    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.
    createdAt 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.
    lastTransitionStatus "CREATING" | "UPDATING" | "CREATE_SUCCESSFUL" | "CREATE_FAILED" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED"
    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.
    retrievalInstructionId String
    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.
    updatedAt 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) -> RetrievalInstruction
    func 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.

    AnswerFormat string
    How the answer is structured, including how sources are cited.
    AnswerPolicy 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.
    RetrievalGuidance string
    How to interpret and decompose the question, and what to prioritise when searching.
    AnswerFormat string
    How the answer is structured, including how sources are cited.
    AnswerPolicy 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.
    RetrievalGuidance 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.
    answerFormat String
    How the answer is structured, including how sources are cited.
    answerPolicy 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.
    retrievalGuidance String
    How to interpret and decompose the question, and what to prioritise when searching.
    answerFormat string
    How the answer is structured, including how sources are cited.
    answerPolicy 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.
    retrievalGuidance 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.
    answerFormat String
    How the answer is structured, including how sources are cited.
    answerPolicy 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.
    retrievalGuidance 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.

    NameValue
    CreatingCREATING
    UpdatingUPDATING
    CreateSuccessfulCREATE_SUCCESSFUL
    CreateFailedCREATE_FAILED
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    NameValue
    RetrievalInstructionLastTransitionStatusCreatingCREATING
    RetrievalInstructionLastTransitionStatusUpdatingUPDATING
    RetrievalInstructionLastTransitionStatusCreateSuccessfulCREATE_SUCCESSFUL
    RetrievalInstructionLastTransitionStatusCreateFailedCREATE_FAILED
    RetrievalInstructionLastTransitionStatusUpdateSuccessfulUPDATE_SUCCESSFUL
    RetrievalInstructionLastTransitionStatusUpdateFailedUPDATE_FAILED
    Value
    CREATING
    UPDATING
    CREATE_SUCCESSFUL
    CREATE_FAILED
    UPDATE_SUCCESSFUL
    UPDATE_FAILED
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    CreateSuccessfulCREATE_SUCCESSFUL
    CreateFailedCREATE_FAILED
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    CreateSuccessfulCREATE_SUCCESSFUL
    CreateFailedCREATE_FAILED
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    NameValue
    CREATINGCREATING
    UPDATINGUPDATING
    CREATE_SUCCESSFULCREATE_SUCCESSFUL
    CREATE_FAILEDCREATE_FAILED
    UPDATE_SUCCESSFULUPDATE_SUCCESSFUL
    UPDATE_FAILEDUPDATE_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.

    NameValue
    ActiveACTIVE
    InactiveINACTIVE
    NameValue
    RetrievalInstructionStatusActiveACTIVE
    RetrievalInstructionStatusInactiveINACTIVE
    Value
    ACTIVE
    INACTIVE
    NameValue
    ActiveACTIVE
    InactiveINACTIVE
    NameValue
    ActiveACTIVE
    InactiveINACTIVE
    NameValue
    ACTIVEACTIVE
    INACTIVEINACTIVE
    Value
    ACTIVE
    INACTIVE

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial